Submits OKF bundles from a domain you control, using the IndexNow protocol.

No account, no payment: ownership is proved by a key file on the host, exactly as IndexNow does it. Host https://<host>/<key>.txt containing the key (or point keyLocation at another path on the SAME host), then send the bundle URLs. We answer 202: the key has not been checked yet. Verification and reading happen on our collector, never at the edge — so nothing is published, and no URL of yours is fetched, before the key matches. Re-sending a URL is how you say the bundle changed; it goes back in line to be re-read. At most 100 URLs per request and 200 per host per UTC day. Bundles in public GitHub repositories need no ping: the sweep finds them. Returns: { ok, estado, host, recebidos, chave_em, mensagem, api_index }

post/api/ping

Request

  • Base URL: https://okfindex.com
  • URL: https://okfindex.com/api/ping
  • Auth: none declared

Request body

urlListstring[] required

The bundle roots (index.md files): https, on host, ending in .md — any path, since the spec fixes none.

hoststring required

The domain that serves the bundles and the key file.

keystring required

The IndexNow key: 8 to 128 characters of [a-zA-Z0-9-].

keyLocationstring

Alternative location of the key file, on the SAME host. Default: https://<host>/<key>.txt.

Response

{ ok, estado, host, recebidos, chave_em, mensagem, api_index }

okboolean required

The submission was queued.

estadostring required

Always pendente: the key has not been checked yet.

hoststring required

The host as normalized (lowercase).

recebidosinteger required

How many distinct URLs entered the queue.

chave_emstring required

Where we will look for the key file. Check it if you are unsure.

mensagemstring required

What happens next, in one sentence.

api_indexstring required

Absolute URL of this API's index.

Changes

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