PilotFoxDocs
REST APIAPI referenceSearch Console

Sync Search Console now

POST
/api/v1/sites/{siteId}/search-console/sync

Queues a sync of the linked property now rather than at the next scheduled run. Send {} as the body: a request without one is 400. 404 when the site has no link, 503 when Google OAuth is not configured.

Requires site:update on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: site:update

Path Parameters

siteId*string

Request Body

application/json
  1. body

Response Body

Accepted

application/json
  1. response
data*
Example Request
curl -X POST 'https://pilotfox.app/api/v1/sites/string/search-console/sync' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response202
{  "data": {    "queued": true  }}