FaultPilot
FaultPilot home

FaultPilot documentation

API Tests

Configure repeatable authenticated API requests and verify the responses your integrations require.

Open in FaultPilot
1

Create the test

  1. Choose the HTTP method and complete public endpoint URL.
  2. Add required headers and request data without placing credentials in names or descriptions.
  3. Configure the expected status or response condition.
  4. Run once before enabling a recurring schedule.
2

Authentication

  1. Use a dedicated least-privilege synthetic credential.
  2. Store private values using the available protected secret fields.
  3. Avoid testing login endpoints so frequently that their abuse controls correctly return HTTP 429.
3

Failure confirmation

  1. Set consecutive failure and recovery thresholds appropriate to business impact.
  2. Timeout, DNS, TLS, and server failures are retried before a cycle counts as failed.
  3. Review execution history before changing a healthy endpoint to accept broader responses.
4

Operational use

  1. Attach the responsible alert destination.
  2. Use incidents for confirmed unplanned failures and maintenance for planned disruption.
  3. Rotate authentication values after exposure or personnel changes.