GuidesRecipesAPI ReferenceChangelog
API Reference

Create or restore an Agent

post
https://api.fido.id/{version}/agent

Create a scheduled Agent. If an archived Agent already exists for the same product, input, and App Key, this operation restores it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The Trustfull product the Agent runs.

Allowed:
string
required
length ≤ 200

A domain without a protocol or path.

string
enum
required

How often the Agent runs a Request.

Allowed:
string

Optional first run date and time in UTC. When omitted, the Agent starts shortly after creation.

integer
0 to 1000
Defaults to 451

Send an alert when the result score is lower than this value.

string
length ≤ 200

Optional email address that receives Agent alerts.

uri
length ≤ 2048

Optional public HTTPS endpoint that receives Agent alerts.

Headers
string
required
Responses

400

Invalid request

401

Invalid App Key

402

Insufficient credits

403

The App Key is not enabled for Agents, which are part of the Enterprise plan

409

An active Agent already exists for this product, input, and App Key

Updated about 7 hours ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 7 hours ago

Did this page help you?