The URL points at a private or loopback host, or redirects to one. Point the URL at a publicly reachable host.
Fix API reference source errors
When an API reference fails to fetch, refresh, or process its specification, it shows one of the errors below. Find your message, apply the fix, and refresh again from the reference's Source tab. How to open a reference and refresh it is covered in Refresh API reference sources.
Specification URL errors
Blocked API specification URL host: <hostname>
Unable to resolve API specification URL host: <hostname>
The host name does not resolve. Check the URL for typos.
Only HTTP(S) API specification URLs are allowed
The URL uses a protocol other than HTTP or HTTPS. Use an HTTP or HTTPS URL.
API specification URL must not include embedded credentials
The URL contains a username and password. Remove the credentials from the URL.
Could not fetch the spec from <host> (HTTP <status>)
The server returned an HTTP error, for example 410 Gone. This is the message shown in the Source tab. Check that the URL still serves the specification.
Unable to fetch API specification (too many redirects, max 5)
The URL redirects more than five times. Point the URL directly at the specification.
The URL returned neither a specification document nor a GraphQL schema. Point it at an OpenAPI file, a GraphQL SDL file, or a GraphQL endpoint with introspection enabled.
The URL served content we cannot read as a spec. Point it at an OpenAPI file, a GraphQL SDL file, or a GraphQL endpoint with introspection enabled.
Specification size errors
API specification exceeds the 15 MB limit.
The specification file is larger than 15 MB. Reduce the file below 15 MB and try again.
GitHub errors
Could not authenticate with GitHub. Try reconnecting the integration.
The GitHub connection can no longer authenticate. Reconnect the GitHub integration, then refresh again. See GitHub integration.
The GitHub path must point at a file
The configured path points at a directory. Point it at the specification file itself.
File not found in the GitHub repository on that ref
The file does not exist on the configured ref. Check the path and the ref, or move the file and update the reference.
The GitHub connection cannot read that repository
The GitHub connection has no access to the repository. Grant the connection access to the repository in GitHub, then refresh again.
Could not read that file from GitHub.
This is the fallback message when the file could not be read. Check the connection, path, and ref, then refresh again.
Processing failures
Processing failed
Processing errored while we read and indexed the spec. The reference stays editable, so replace the spec and try again.
Was this helpful?
Was this helpful?