Skip to main content
GET
Get IndexNow key
Returns the IndexNow key of your website and the key file status of each host. Aranx generates one key per website. Serve the key file at the root of each host, then call Verify IndexNow Key File. See Search engine notification for the full setup.

Example request

Response

Response fields

Aranx adds a host to hosts when you report an article URL on that host with Update Article.

Host status

Aranx checks the key file before the first submission and then about every 24 hours.

Error responses

Authorizations

Authorization
string
header
required

API key from your Aranx dashboard. Pass it as a Bearer token in the Authorization header.

Response

The IndexNow key and the status of each host.

key
string
required

The IndexNow key of your website. Aranx generates one key per website.

Pattern: ^[0-9a-f]{32}$
Example:

"3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d"

key_file
string
required

Name of the key file. Serve it at the root of each host. Its only content is key.

Example:

"3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d.txt"

hosts
object[]
required

Hosts that Aranx submits URLs for. The first item is the host of the connection's site URL. Aranx adds a host when you report an article URL on that host.