Run Security Agent

POST

apps

{appId}

security-agent

Run Security Agent

curl --request POST \
  --url https://api.perfai.ai/v1/apps/{appId}/security-agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.perfai.ai/v1/apps/{appId}/security-agent"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.perfai.ai/v1/apps/{appId}/security-agent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perfai.ai/v1/apps/{appId}/security-agent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perfai.ai/v1/apps/{appId}/security-agent"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.perfai.ai/v1/apps/{appId}/security-agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perfai.ai/v1/apps/{appId}/security-agent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "taskId": "<string>",
  "appId": "<string>",
  "state": "QUEUED",
  "reason": "needs_login",
  "message": "We hit a snag — we're on it. Your results so far are saved.",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "statusUrl": "<string>",
  "runNumber": 123
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

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>

Same vocabulary as TaskState. Never FAILED.

Available options:

QUEUED,

RUNNING,

NEEDS_INPUT,

COMPLETED,

COMPLETED_PARTIAL,

INTERRUPTED,

CANCELLED

reason

enum<string> | null

Why a task or app is in its state. Null when the state needs no explanation. New values may be added; show message for any you do not recognise.

Available options:

needs_login,

needs_roles,

needs_access,

needs_app_url,

needs_spec,

app_unreachable,

out_of_credits,

no_response,

paused,

partial_coverage,

our_side_error,

dependency_lost,

null

message

string

One sentence for the user — the same wording the console shows for this state.

Example:

"We hit a snag — we're on it. Your results so far are saved."

createdAt

string<date-time> | null

updatedAt

string<date-time> | null

statusUrl

string

runNumber

integer

Monotonically increasing counter per app (status endpoint only).

Run Security Agent

curl --request POST \
  --url https://api.perfai.ai/v1/apps/{appId}/security-agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.perfai.ai/v1/apps/{appId}/security-agent"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.perfai.ai/v1/apps/{appId}/security-agent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perfai.ai/v1/apps/{appId}/security-agent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perfai.ai/v1/apps/{appId}/security-agent"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.perfai.ai/v1/apps/{appId}/security-agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perfai.ai/v1/apps/{appId}/security-agent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "taskId": "<string>",
  "appId": "<string>",
  "state": "QUEUED",
  "reason": "needs_login",
  "message": "We hit a snag — we're on it. Your results so far are saved.",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "statusUrl": "<string>",
  "runNumber": 123
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

{
  "type": "<string>",
  "title": "<string>"
}

Getting Started

Core Concepts

Hybrid Deployment

Changelog

Authorizations

Path Parameters

Body

Response