landing-pages

Embed

<a href="https://hermeticor.com/docs/ref-landing-pages"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/c6be5417-6c86-4c1d-96eb-b62b10fbdcb8/social-card.svg?v=3e7ae33eec8b" alt="landing-pages" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/page-sites

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/page-sites" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "homePageId": "string",
      "header": {
        "title": ""
      },
      "menu": [],
      "footerMenu": [],
      "footerHtml": "",
      "theme": {
        "background": "#ffffff",
        "text": "#111111",
        "accent": "#1f6feb"
      },
      "id": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "pageCount": 0,
      "domain": "string",
      "domainStatus": "none",
      "domainError": "string",
      "domainVerifiedAt": "2024-01-01T00:00:00Z",
      "records": [
        {
          "type": "TXT",
          "name": "string",
          "value": "string"
        }
      ],
      "url": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem214[]required

Show child parameters

namestringrequired

homePageIdstring

headerobjectrequired

= {"title":""}

Show child parameters

titlestringrequired

logoUrlstring

menuMenuItem[]required

= []

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerMenuMenuItem[]required

= []

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerHtmlstringrequired

themeobjectrequired

= {"background":"#ffffff","text":"#111111","accent":"#1f6feb"}

Show child parameters

backgroundstringrequired

= #ffffff

textstringrequired

= #111111

accentstringrequired

= #1f6feb

idstringrequired

createdAtstringrequired

pageCountintegerrequired

domainstringrequired

domainStatusstringrequired

none | pending | checking | verified | failed

domainErrorstringrequired

domainVerifiedAtstringrequired

recordsRecordsItem3[]required

Show child parameters

typestringrequired

TXT | CNAME

namestringrequired

valuestringrequired

urlstringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/page-sites

POSThttps://hermeticor.com/v1/page-sites

Create a website: pages that share a header, footer and menus

Request body

application/json

namestringrequired

homePageIdstring

headerobject

= {"title":""}

Show child parameters

titlestring

logoUrlstring

menuMenuItem2[]

= []

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerMenuMenuItem2[]

= []

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerHtmlstring

themeobject

= {"background":"#ffffff","text":"#111111","accent":"#1f6feb"}

Show child parameters

backgroundstring

= #ffffff

textstring

= #111111

accentstring

= #1f6feb

{
  "name": "string",
  "homePageId": "string",
  "header": {
    "title": ""
  },
  "menu": [],
  "footerMenu": [],
  "footerHtml": "",
  "theme": {
    "background": "#ffffff",
    "text": "#111111",
    "accent": "#1f6feb"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/page-sites" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","homePageId":"string","header":{"title":""},"menu":[],"footerMenu":[],"footerHtml":"","theme":{"background":"#ffffff","text":"#111111","accent":"#1f6feb"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "homePageId": "string",
  "header": {
    "title": ""
  },
  "menu": [],
  "footerMenu": [],
  "footerHtml": "",
  "theme": {
    "background": "#ffffff",
    "text": "#111111",
    "accent": "#1f6feb"
  },
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "pageCount": 0,
  "domain": "string",
  "domainStatus": "none",
  "domainError": "string",
  "domainVerifiedAt": "2024-01-01T00:00:00Z",
  "records": [
    {
      "type": "TXT",
      "name": "string",
      "value": "string"
    }
  ],
  "url": "string"
}

Schema

namestringrequired

homePageIdstring

headerobjectrequired

= {"title":""}

Show child parameters

titlestringrequired

logoUrlstring

menuMenuItem[]required

= []

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerMenuMenuItem[]required

= []

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerHtmlstringrequired

themeobjectrequired

= {"background":"#ffffff","text":"#111111","accent":"#1f6feb"}

Show child parameters

backgroundstringrequired

= #ffffff

textstringrequired

= #111111

accentstringrequired

= #1f6feb

idstringrequired

createdAtstringrequired

pageCountintegerrequired

domainstringrequired

domainStatusstringrequired

none | pending | checking | verified | failed

domainErrorstringrequired

domainVerifiedAtstringrequired

recordsRecordsItem3[]required

Show child parameters

typestringrequired

TXT | CNAME

namestringrequired

valuestringrequired

urlstringrequired

4XX Default Response

Same as 4XX · GET /v1/page-sites

5XX Default Response

Same as 4XX · GET /v1/page-sites

GEThttps://hermeticor.com/v1/page-sites/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/page-sites/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/page-sites

4XX Default Response

Same as 4XX · GET /v1/page-sites

5XX Default Response

Same as 4XX · GET /v1/page-sites

DELETEhttps://hermeticor.com/v1/page-sites/{id}

Delete the site (its pages stay, unassigned) and stop serving its domain

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/page-sites/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/page-sites

5XX Default Response

Same as 4XX · GET /v1/page-sites

PATCHhttps://hermeticor.com/v1/page-sites/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

homePageIdstring

headerobject

Show child parameters

titlestring

logoUrlstring

menuMenuItem2[]

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerMenuMenuItem2[]

Show child parameters

labelstringrequired

pageIdstring

urlstring

footerHtmlstring

themeobject

Show child parameters

backgroundstring

= #ffffff

textstring

= #111111

accentstring

= #1f6feb

{
  "name": "string",
  "homePageId": "string",
  "header": {
    "title": "",
    "logoUrl": "string"
  },
  "menu": [
    {
      "label": "string",
      "pageId": "string",
      "url": "string"
    }
  ],
  "footerMenu": [
    {
      "label": "string",
      "pageId": "string",
      "url": "string"
    }
  ],
  "footerHtml": "string",
  "theme": {
    "background": "#ffffff",
    "text": "#111111",
    "accent": "#1f6feb"
  }
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/page-sites/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","homePageId":"string","header":{"title":"","logoUrl":"string"},"menu":[{"label":"string","pageId":"string","url":"string"}],"footerMenu":[{"label":"string","pageId":"string","url":"string"}],"footerHtml":"string","theme":{"background":"#ffffff","text":"#111111","accent":"#1f6feb"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/page-sites

4XX Default Response

Same as 4XX · GET /v1/page-sites

5XX Default Response

Same as 4XX · GET /v1/page-sites

PUThttps://hermeticor.com/v1/page-sites/{id}/domain

Set the custom domain; publish the returned DNS records, then verify

Parameters

idstringpathrequired

Request body

application/json

domainstringrequired

{
  "domain": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/page-sites/{id}/domain" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/page-sites

4XX Default Response

Same as 4XX · GET /v1/page-sites

5XX Default Response

Same as 4XX · GET /v1/page-sites

DELETEhttps://hermeticor.com/v1/page-sites/{id}/domain

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/page-sites/{id}/domain" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/page-sites

4XX Default Response

Same as 4XX · GET /v1/page-sites

5XX Default Response

Same as 4XX · GET /v1/page-sites

Next part

Updated Nov 8, 2026

Was this page helpful?