snout.nu help

API

June 10, 2025 at 2:40 PM • 1 min read • 104 words

You can use the API to view public posts. The base URL is https://snout.nu/api.

Posts

/posts/build/SITE_ID (GET)

Gets all published posts for a user. Returns:

[
  {
    "title": "Hello world!",
    "content": "Content in markdown",
    "date": "2025-04-17T23:33:42.365Z"
  }
]

/site/build/SITE_ID (GET)

Gets the site configuration for a site. Returns:

{
  "id": "example",
  "createdAt": "2025-04-15T16:01:54.055Z",
  "updatedAt": "2025-04-19T20:54:16.248Z",
  "active": true,
  "title": "snout.nu help",
  "description": "Here you can see our articles on how to use snout.nu",
  "customDomain": "example.com",
  "idSubdomainUmami": "59162de6-d255-4c91-904e-0f9a662a4419",
  "idDomainUmami": "17210a07-910c-44a8-a5cf-e8f5ca0c853e"
}

/caddy/ask?domain=(SUB)DOMAIN (GET)
Determines if a domain is hosted on snout. Will return 200 OK or 404 Not Found.