readiness

Start a scan of one of your verified domains (one per domain per 24 hours)

Asynchronous: answers 202 with the scan id; poll getReadinessScan until status is complete or partial (typically 5–30 s). The domain must be on the client's scan list and verified (DNS TXT or well-known file, set up on the portal account page). Requires the aeo scope and a key whose user holds the manage-integrations grant.

post/readiness/scan

Request

  • Base URL: https://portal.fractionalteams.com/api/v1
  • URL: https://portal.fractionalteams.com/api/v1/readiness/scan
  • Auth: HTTP bearer

Request body

targetstring required

A domain on the client's scan list, e.g. www.example.com

Response

Never returned, documented for tooling that requires a 200; the success response is 202

scan_idinteger required
domainstring required
status'running' required

Changes

No recorded changes to this operation across all 1 revision of this API.