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>

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

Queue a DNS check (status `checking` until it lands); once verified the domain is added to the proxy routing file (TLS is issued automatically)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

PUThttps://hermeticor.com/v1/landing-pages/{id}/site

Put the page in a website (null takes it out)

Parameters

idstringpathrequired

Request body

application/json

siteIdstringrequired

{
  "siteId": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "draft",
  "publishedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

slugstringrequired

statusstringrequired

draft | published

publishedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

GEThttps://hermeticor.com/v1/landing-page-templates

Built-in page presets for `template_id`, and a link to more

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "blank",
      "name": "string",
      "description": "string",
      "category": "string"
    }
  ],
  "storeUrl": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

descriptionstringrequired

categorystringrequired

storeUrlstringrequired

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

GEThttps://hermeticor.com/v1/landing-pages/{id}/content

The page rendered to HTML (draft by default), with its block document

Parameters

versionstringquery

draft | published = draft

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "version": "draft",
  "html": "string",
  "doc": {}
}

Schema

idstringrequired

versionstringrequired

draft | published

htmlstringrequired

docrequired

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

POSThttps://hermeticor.com/v1/landing-pages/{id}/archive

Hide the page from the list and stop serving it

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/landing-pages/{id}/archive" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/landing-pages/{id}/site

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

POSThttps://hermeticor.com/v1/landing-pages/{id}/unarchive

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/landing-pages/{id}/unarchive" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/landing-pages/{id}/site

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

GEThttps://hermeticor.com/v1/landing-pages/seo/audit

SEO audit of every page: score and recommendations

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/landing-pages/seo/audit" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "pageId": "string",
      "score": 0,
      "issues": [
        {
          "code": "string",
          "severity": "error",
          "message": "string"
        }
      ],
      "keyword": "string",
      "words": 0,
      "name": "string",
      "slug": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

pageIdstringrequired

scoreintegerrequired

issuesIssuesItem[]required

Show child parameters

codestringrequired

severitystringrequired

error | warning | info

messagestringrequired

keywordstringrequired

wordsintegerrequired

namestringrequired

slugstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

GEThttps://hermeticor.com/v1/landing-pages/{id}/seo

SEO recommendations for one page (draft)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "pageId": "string",
  "score": 0,
  "issues": [
    {
      "code": "string",
      "severity": "error",
      "message": "string"
    }
  ],
  "keyword": "string",
  "words": 0
}

Schema

pageIdstringrequired

scoreintegerrequired

issuesIssuesItem[]required

Show child parameters

codestringrequired

severitystringrequired

error | warning | info

messagestringrequired

keywordstringrequired

wordsintegerrequired

4XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

5XX Default Response

Same as 4XX · POST /v1/page-sites/{id}/domain/verify

PUThttps://hermeticor.com/v1/landing-pages/{id}/seo/keyword

Set the focus keyword the audit checks

Parameters

idstringpathrequired

Request body

application/json

keywordstringrequired

{
  "keyword": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java