Well-known URI


A well-known URI is a Uniform Resource Identifier for URL path prefixes that start with /.well-known/. They are implemented in webservers so that requests to the servers for well-known services or information are available at URLs consistent well-known locations across servers.

Description

Well-known URIs are Uniform Resource Identifiers defined by the IETF in RFC 8615. They are URL path prefixes that start with /.well-known/. This implementation is in response to the common expectation for web-based protocols to require certain services or information be available at URLs consistent across servers, regardless of the way URL paths are organized on a particular host. The URIs are implemented in webservers so that requests to the servers for well-known services or information are available at URLs consistently in well-known locations across servers.
The IETF has defined a simple way for web servers to hold metadata that any user agent can request. The metadata is useful for various tasks, including directing a web user to use a mobile app instead of the website or indicating the different ways that the site can be secured. The well-known locations are used by web servers to share metadata with user agents; sometimes these are files and sometimes these are requests for information from the web server software itself. The way to declare the different metadata requests that can be provided is standardized by the IETF so that other developers know how to find and use this information.

Use

The path well-known URI begins with the characters /.well-known/, and whose scheme is "HTTP", "HTTPS", or another scheme that has explicitly been specified to use well-known URIs. As an example, if an application hosts the service "example", the corresponding well-known URIs on https://www.example.com/ would start with https://www.example.com/.well-known/example.
Information shared by a web site as a well-known service is expected to meet a specific standard. Specifications that need to define a resource for such site-wide metadata can register their use with the Internet Assigned Numbers Authority to avoid collisions and minimize impingement upon sites' URI space.

List of well-known URIs

The list below describes known standards for.well-known services that a web server can implement.
URI suffixDescriptionReferenceDate of IANA registration
acme-challengeAutomated Certificate Management Environment 2019-03-01
agent-card.jsonDetails for an A2A Server's Agent Card
ai-plugin.jsonManifest for a ChatGPT plugin
apple-app-site-associationAn Apple service that enables secure data exchange between iOS and a website
apple-developer-merchantid-domain-associationApple Pay
appspecificUsed by some application to get some informations about the application
ashraeBACnetA data communication protocol for building automation and control networks2016-01-22
assetlinks.jsonAssetLinks protocol used to identify one or more digital assets that are related to the hosting web site in some fashion2015-09-28
atproto-didHandle-to-DID resolution for AT Protocol
autoconfig/mailMozilla Thunderbird mail autoconfiguration service
browseridMozilla Persona
caldavCalendaring Extensions to WebDAV and vCard Extensions to WebDAV
carddavCalendaring Extensions to WebDAV and vCard Extensions to WebDAV
change-passwordHelps password managers find the URL for changing client account passwords
coapCoAP over TCP, TLS, and WebSockets2017-12-22
com.apple.remotemanagementApple-Account–based user enrollment for mobile device management
com.chrome.devtools.json for Web_development_tools-
coreConstrained RESTful Environments Link Format
csvmCSV metadata, Model for Tabular Data and Metadata on the Web2015-09-28
datLinks domain to Dat identifier, used by Beaker web browser
did.json Decentralized Identifiers for the Web
discordDomain verification for Discord account connection
dntSite-wide tracking status resource2015-08-19
dnt-policy.txtA privacy-friendly Do Not Track Policy2015-08-19
estEnrollment over Secure Transport 2013-08-16
genidResource Description Framework Skolem IRIs2012-11-15
gpc.jsonGlobal Privacy Control
hobaHTTP Origin-Bound Authentication 2015-01-20
host-metaWeb Host Metadata
host-meta.jsonWeb Host Metadata
http-opportunisticOpportunistic Security for HTTP/22017-03-20
keybase.txtUsed by the Keybase project to identify a proof that one or more people whose public keys may be retrieved using the Keybase service have administrative control over the origin server from which it is retrieved2014-04-08
keyparcUsed by the Bloombase Keyparc project to secure online digital assets using cryptography over web services2012-09-23
matrixProvides discovery for both client and server APIs to the Matrix federated protocol
mercureDiscovery of Mercure hubs. Mercure is a protocol enabling the pushing of data updates to web browsers and other HTTP clients in a fast, reliable and battery-efficient way.
mta-sts.txtSMTP MTA Strict Transport Security Policy2018-06-21
niNaming Things with Hashes
nodeinfoMetadata for federated social networking servers
nostr.jsonDiscovery of Nostr public keys and related relays, according to 2024-03-18
oauth-authorization-serverOAuth Authorization Server Metadata2018-03-27
openid-configurationOpenID Connect2013-08-27
openorgOrganisation Profile Document2015-05-29
openpgpkeyOpenPGP Web Key Service
org.flathub.VerifiedApps.txtVerifies that an app is associated with given domain in Flathub
passkey-endpointsFormally advertises support for passkeys and provides direct links for enrollment and management for password managers to automatically create/upgrade.
pki-validationCA/Browser Forum’s Baseline Requirements Certificate Policy for the Issuance and Management of Publicly-Trusted Certificates2017-02-06
poshPKIX over Secure HTTP 2015-09-20
privacy-sandbox-attestations.jsonThe Google Chrome Privacy Sandbox attestation file
pubvendors.jsonThe IAB pubvendors.json tech spec, which provide a standard for publishers to publicly declare the vendors that they work with, and their respective data rights/configuration2020-09-07
reload-configREsource LOcation And Discovery Base Protocol
repute-templateA Reputation Query Protocol2013-09-30
resourcesyncResourceSync Framework Specification2017-05-26
security.txtStandard to help organizations define the process for security researchers to disclose security vulnerabilities2018-08-20
smart-configurationSMART on FHIR configuration metadata, including OAuth authorization_endpoint and token_endpoint URLs2023-03-01
statements.txtStandard for collective contract signing
stun-keySession Traversal Utilities for NAT Extension for Third-Party Authorization2015-06-12
tdmrep.jsonDomain-wide TDM reservation
timeTime over HTTPS specification2015-12-09
timezoneTime Zone Data Distribution Service2015-08-03
traffic-advicePrefetch control -
uma2-configurationUser-Managed Access 2.0 grant for OAuth 2.0 authorization2017-06-20
vercel/flagsOverridable Feature Flag's for Vercel's Toolbar
voidDescribing Linked Datasets with the VoID Vocabulary2011-05-11
wasm-pkg/registry.jsonWebAssembly registry
webauthnWebAuthn Related Origins
webfingerWebFinger2013-03-15, 2013-09-06
workflow Routes
xrp-ledger.tomlXRP ledger node & account information