> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aranx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get IndexNow Key

> Returns the IndexNow key of your website and the key file status of each host

```
GET /api/v1/public/indexnow
```

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](https://docs.aranx.com/api-reference/indexnow/verify-indexnow.md).
See [Search engine notification](https://docs.aranx.com/integrations/indexnow.md) for the full setup.

## Example request

```typescript TypeScript theme={null}
const response = await fetch('https://api.aranx.com/api/v1/public/indexnow', {
  headers: { Authorization: 'Bearer YOUR_API_KEY' }
});
const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.get(
    "https://api.aranx.com/api/v1/public/indexnow",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = response.json()
```

```bash curl theme={null}
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.aranx.com/api/v1/public/indexnow
```

## Response

```json theme={null}
{
  "key": "3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d",
  "key_file": "3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d.txt",
  "hosts": [
    {
      "host": "www.example.com",
      "key_file_url": "https://www.example.com/3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d.txt",
      "status": "verified",
      "last_checked_at": "2026-11-19T10:00:00.000Z",
      "last_verified_at": "2026-11-19T10:00:00.000Z",
      "last_error": null
    }
  ]
}
```

## Response fields

| Field | Type | Description |
| - | - | - |
| `key` | `string` | The IndexNow key: 32 hexadecimal characters |
| `key_file` | `string` | Name of the key file, `{key}.txt` |
| `hosts` | `array` | Hosts that Aranx submits URLs for. The first item is the host of the connection's site URL |
| `hosts[].host` | `string` | Host name. `www.example.com` and `example.com` are separate hosts |
| `hosts[].key_file_url` | `string` | URL where Aranx checks the key file |
| `hosts[].status` | `string` | `not_set_up`, `verified`, or `failing`. See [Host status](#host-status) |
| `hosts[].last_checked_at` | `string \| null` | When Aranx last checked the key file |
| `hosts[].last_verified_at` | `string \| null` | When the key file last passed the check |
| `hosts[].last_error` | `string \| null` | Short reason for the last failed check, for example `"The key file returned HTTP 404."` |

Aranx adds a host to `hosts` when you report an article URL on that host with
[Update Article](https://docs.aranx.com/api-reference/articles/update-article.md).

## Host status

| Status | Meaning |
| - | - |
| `not_set_up` | The key file never passed a check. Aranx submits no URLs on this host |
| `verified` | The last check passed. Aranx submits URLs on this host |
| `failing` | The host was verified before or IndexNow rejected the key, and the key file no longer passes. Aranx stops submitting |

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

## Error responses

| Status | Description |
| - | - |
| `401` | Missing or invalid API key |
| `403` | Subscription inactive |
| `429` | Rate limit exceeded |


## OpenAPI

````yaml GET /api/v1/public/indexnow
openapi: 3.1.0
info:
  title: Aranx Public API
  description: >-
    REST API for accessing articles and categories from your Aranx-powered blog,
    and for setting up IndexNow.
  version: 1.0.0
servers:
  - url: https://api.aranx.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Articles
    description: >-
      Retrieve blog articles and their content, and report their publication
      status on your site.
  - name: Categories
    description: >-
      Manage blog categories. Write operations (create, update, delete) are only
      available for API connection types.
  - name: IndexNow
    description: >-
      Get the IndexNow key of your website and check the key file on each host.
      Aranx submits article URLs to IndexNow only for hosts whose key file it
      verified.
paths:
  /api/v1/public/indexnow:
    get:
      tags:
        - IndexNow
      summary: Get IndexNow key
      description: >-
        Returns the IndexNow key of your website and the key file status of each
        host. Serve the key file at the root of each host, then call `POST
        /api/v1/public/indexnow/verify`.
      operationId: getIndexNow
      responses:
        '200':
          description: The IndexNow key and the status of each host.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexNowState'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  headers:
    X-RateLimit-Limit:
      description: Maximum number of requests allowed per minute.
      schema:
        type: integer
        example: 100
    X-RateLimit-Remaining:
      description: Number of requests remaining in the current window.
      schema:
        type: integer
        example: 95
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the rate limit window resets.
      schema:
        type: integer
        example: 1700000000
  schemas:
    IndexNowState:
      type: object
      required:
        - key
        - key_file
        - hosts
      properties:
        key:
          type: string
          pattern: ^[0-9a-f]{32}$
          description: >-
            The IndexNow key of your website. Aranx generates one key per
            website.
          example: 3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d
        key_file:
          type: string
          description: >-
            Name of the key file. Serve it at the root of each host. Its only
            content is `key`.
          example: 3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d.txt
        hosts:
          type: array
          description: >-
            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.
          items:
            $ref: '#/components/schemas/IndexNowHost'
    IndexNowHost:
      type: object
      required:
        - host
        - key_file_url
        - status
        - last_checked_at
        - last_verified_at
        - last_error
      properties:
        host:
          type: string
          description: Host name. `www.example.com` and `example.com` are separate hosts.
          example: www.example.com
        key_file_url:
          type: string
          format: uri
          description: URL where Aranx checks the key file on this host.
          example: https://www.example.com/3f2a9c41d07e4b6a8c5d2e1f0a9b8c7d.txt
        status:
          $ref: '#/components/schemas/IndexNowHostStatus'
        last_checked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When Aranx last checked the key file. `null` before the first check.
          example: '2026-11-19T10:00:00.000Z'
        last_verified_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the key file last passed the check. `null` if it never passed.
          example: '2026-11-19T10:00:00.000Z'
        last_error:
          type:
            - string
            - 'null'
          description: >-
            Short English reason for the last failed check. `null` when the last
            check passed or no check ran.
          example: null
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: A human-readable error message.
          example: Invalid API key
        details:
          type: object
          description: Field-level validation errors, if applicable.
          additionalProperties:
            type: array
            items:
              type: string
    IndexNowHostStatus:
      type: string
      enum:
        - not_set_up
        - verified
        - failing
      description: >-
        `not_set_up`: the key file never passed a check. `verified`: the last
        check passed, and Aranx submits URLs on this host. `failing`: the host
        was verified before or IndexNow rejected the key, and the key file no
        longer passes the check. Aranx submits no URLs on this host until the
        file passes again.
      example: verified
  responses:
    Unauthorized:
      description: >-
        Authentication failed. Check that your API key is valid and passed as a
        Bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid API key
    Forbidden:
      description: Your subscription is inactive. Reactivate it in the Aranx dashboard.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 'API access suspended: subscription inactive'
    RateLimited:
      description: You have exceeded the rate limit of 100 requests per minute.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          description: Seconds until the rate limit window resets.
          schema:
            type: integer
            example: 30
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate limit exceeded
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from your Aranx dashboard. Pass it as a Bearer token in the
        `Authorization` header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.