---
title: "Get the SPF include index"
method: GET
path: "/sources/spf-index"
tags: ["Source"]
---

# Get the SPF include index

`GET /sources/spf-index`

## Request

- Base URL: `https://api.palisade.email`
- URL: `https://api.palisade.email/sources/spf-index`
- Auth: one of:
  - none
  - HTTP bearer
  - HTTP basic

The compact include-to-sender index used to name the mechanisms in an SPF record, and to offer senders to add. Only sources that carry at least one SPF value appear. `values` holds the mechanisms Palisade prescribes adding; `recognition_values` additionally holds observed values, which name a mechanism already present in a record but are not safe to publish on a user's behalf. Authentication is optional, as on the list endpoint.

## Response `200`

Success

- object
  - `data` object[], required
    - `id` string, uuid, required
    - `name` string, required
    - `logo_url` string, nullable, required
    - `homepage` string, uri, nullable, required
    - `values` string[], required: SPF mechanisms Palisade prescribes adding for this source. Safe to publish on a user's behalf.
    - `recognition_values` string[], required: Every mechanism that identifies this source, including values only observed in the wild. Use these to name a mechanism already present in a record; they are not safe to add to one.
    - `requires_advanced_config` boolean, required: When true, the mechanism depends on per-customer setup and must not be offered as a one-click add.
  - `page_info` object, required
    - `count` number, required
    - `page` number, required
    - `per_page` number, required

---

[API](https://skmtc.dev/palisade/apis/palisade-api.md) · [All operations](https://skmtc.dev/palisade/apis/palisade-api/llms.txt) · [OpenAPI document](https://skmtc.dev/palisade/apis/palisade-api/revisions/aabc77d12934?raw)