Domains
Add, list, remove, and verify workspace domains, and look up DNS records.
- PlanEnterprise to add or verify, Pro for the rest
- WhoOwners and admins to list, add, remove, or verify
- Scopesdomains:read, domains:write
Endpoints
Verification responses
A missing or wrong DNS record is not an HTTP error. The request succeeds with 200 and verified: false, so a client can show the fix without retrying. If the DNS lookup cannot run, the API returns 502.
No record found
{
"verified": false,
"domain": "example.com",
"error": "No TXT record found for _projectfeed-verification.example.com",
"instructions": "Add a TXT record with name \"_projectfeed-verification.example.com\" and value \"projectfeed-domain-verification=abc123\""
}Record found with a different value
{
"verified": false,
"domain": "example.com",
"error": "TXT record found but value doesn't match",
"expected": "projectfeed-domain-verification=abc123"
}A domain that is already verified returns verified: true with its verifiedAt time and skips the DNS lookup.
Add and verify a domain
- Add the domain with
POST /domains. The response has the record name inverificationRecordand the value inverificationValue. The value is returned only here, so store it. To get a new one, remove the domain and add it again. A TXT record is named_projectfeed-verification.<domain>with the valueprojectfeed-domain-verification=<token>. A CNAME record is namedprojectfeed-verify.<domain>and points to<token>.verify.projectfeed.app. Every domain has its own token. - Publish that record with your DNS provider. Keep the quotes only if the provider requires them around a TXT value.
- Call
check-dnswith the record name and type, and confirm the expected value appears in the returned records. - Call
domains/verifywith the domain ID. If it returnsverified: false, readerrorandinstructionsorexpected, fix the record, and wait for DNS to update before trying again.
curl --request POST \
--url 'https://projectfeed.app/api/v1/domains' \
--header 'Authorization: Bearer pf_YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{ "domain": "example.com", "verificationMethod": "dns_txt" }'Fix domain verification
No record is returned
Check the record name and type, then wait through your provider's DNS propagation and TTL before trying again.
The value does not match
Compare the full expected and returned values. Remove extra spaces and account for quotes that the provider adds around TXT values.
409 conflict
Another workspace verified the domain first. Ask that workspace to remove it, then verify again.
409 when adding a domain
The domain is already added to this workspace, or another workspace added or verified it. Remove the existing entry first, or ask the other workspace to.
400 when adding a domain
The name is not a valid domain name. Send a name such as example.com, up to 253 characters.
403 plan_required when adding a domain
Adding a domain needs an Enterprise plan. Listing and removing domains do not, so you can still remove one after a downgrade.
The verification value is lost
It is returned only when the domain is added. Remove the domain and add it again to get a new value.
404 not found
Use the ID of a domain record in this workspace. A record that belongs to another workspace also returns 404.
403 forbidden
Check the domains scope, the key owner's role (owner or admin), and that the workspace is on Enterprise.
429 or 502
Wait for Retry-After on a 429. For a 502, the DNS lookup failed. Wait and retry before changing a correct DNS record.
See API errors and rate limits.