Get app (poll registration) - Perfai Security

GET

/

apps

/

{appId}

Get app (poll registration)

curl --request GET \
  --url https://api.perfai.ai/v1/apps/{appId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.perfai.ai/v1/apps/{appId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "appId": "<string>",
  "label": "<string>",
  "appUrl": "<string>",
  "basePath": "<string>",
  "registrationStatus": "PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "scheduleType": "nightly"
}

{
  "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).

Response

The app.

appId

string

label

string

appUrl

string

basePath

string

registrationStatus

enum<string>

Onboarding state. COMPLETED, FAILED, and CANCELLED are terminal.

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

FAILED,

CANCELLED

createdAt

string<date-time> | null

scheduleType

enum<string>

How often this app is re-tested automatically. Apps inherit your organization default at registration and fall back to nightly, so an app may be on a recurring cadence you did not request here — each run consumes credits. Change it in the console (Edit app); this API does not set it, matching the console prompt.

Available options:

none,

nightly,

custom,

weekly_saturday,

biweekly_saturday,

monthly_first

Example:

"nightly"

Get app (poll registration)

curl --request GET \
  --url https://api.perfai.ai/v1/apps/{appId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.perfai.ai/v1/apps/{appId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "appId": "<string>",
  "label": "<string>",
  "appUrl": "<string>",
  "basePath": "<string>",
  "registrationStatus": "PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "scheduleType": "nightly"
}

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