Sites

Get a site

One site with its url and its files, without their content.

get/sites/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/sites/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Path parameters

idstring uuid required

The id of the site.

Response

The site.

idstring uuid required

The id of the site. Use it to update or delete the site.

slugstring required

The first part of the address: https://<slug>.hypamoon.app.

namestring required

Your name for the site.

urlstring required

The public address of the site, live right away.

created_atstring date-time required

When the site was created.

updated_atstring date-time required

When the site or its files last changed.

versionstring required

The version that is live now. Changes on every update; every file on the site carries it as its ETag, so you can check that a page shows this version.

password_protectedboolean required

true when visitors have to enter the site's password first (set with password on POST /sites or PUT /sites/{id}). The password itself is never returned.

testboolean required

true for a site of a test project. It is public all the same.

Changes

No recorded changes to this operation across all 1 revision of this API.