sites

Embed

<a href="https://hermeticor.com/docs/ref-sites"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/ae5b2193-2438-4617-9c90-2cccf3eb3194/social-card.svg?v=3e7ae33eec8b" alt="sites" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/sites/{id}/health

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "lastEventByType": [
    {
      "name": "string",
      "lastSeenAt": "string",
      "count24h": 0
    }
  ],
  "originMismatches": [
    {
      "origin": "string",
      "count": 0,
      "lastSeenAt": "string"
    }
  ],
  "consentRejections": {
    "count": 0,
    "lastSeenAt": "string"
  },
  "sdkVersions": [
    {
      "version": "string",
      "share": 0
    }
  ]
}

Schema

lastEventByTypeobject[]required

Show child parameters

namestringrequired

lastSeenAtstringrequired

count24hintegerrequired

originMismatchesobject[]required

Show child parameters

originstringrequired

countintegerrequired

lastSeenAtstringrequired

consentRejectionsobjectrequired

Show child parameters

countintegerrequired

lastSeenAtstringrequired

sdkVersionsobject[]required

Show child parameters

versionstringrequired

sharenumberrequired

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/sites/{id}/health

GEThttps://hermeticor.com/v1/sites

List sites and their site keys: a signed-in user or a secret key with api_keys:read

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/sites" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "domain": "string",
      "enabled": true,
      "verifiedAt": "2024-01-01T00:00:00Z",
      "consentMode": "string",
      "botFilter": true,
      "originAllowlist": [
        "string"
      ],
      "ipAllowlist": [
        "string"
      ],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem106[]required

Show child parameters

idstringrequired

namestringrequired

domainstringrequired

enabledbooleanrequired

verifiedAtstringrequired

consentModestringrequired

botFilterbooleanrequired

originAllowliststring[]required

ipAllowliststring[]required

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

POSThttps://hermeticor.com/v1/sites

Request body

application/json

namestringrequired

domainstringrequired

consentModestring

open | require_consent = require_consent

botFilterboolean

= true

{
  "name": "string",
  "domain": "string",
  "consentMode": "require_consent",
  "botFilter": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sites" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","domain":"string","consentMode":"require_consent","botFilter":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "enabled": true,
  "verifiedAt": "2024-01-01T00:00:00Z",
  "consentMode": "string",
  "botFilter": true,
  "originAllowlist": [
    "string"
  ],
  "ipAllowlist": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "plaintext": "string"
}

Schema

idstringrequired

namestringrequired

domainstringrequired

enabledbooleanrequired

verifiedAtstringrequired

consentModestringrequired

botFilterbooleanrequired

originAllowliststring[]required

ipAllowliststring[]required

createdAtstringrequired

plaintextstringrequired

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "enabled": true,
  "verifiedAt": "2024-01-01T00:00:00Z",
  "consentMode": "string",
  "botFilter": true,
  "originAllowlist": [
    "string"
  ],
  "ipAllowlist": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

domainstringrequired

enabledbooleanrequired

verifiedAtstringrequired

consentModestringrequired

botFilterbooleanrequired

originAllowliststring[]required

ipAllowliststring[]required

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

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

Revokes the site key

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/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/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

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

Rename, change domain, or enable/disable tracking (the pixel)

Parameters

idstringpathrequired

Request body

application/json

namestring

domainstring

enabledboolean

{
  "name": "string",
  "domain": "string",
  "enabled": true
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/sites/{id}

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

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

Verified once the snippet has sent a browser event

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/sites/{id}

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

GEThttps://hermeticor.com/v1/sites/{id}/allowlist

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "origins": [],
  "ips": []
}

Schema

originsstring[]required

= []

ipsstring[]required

= []

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

PUThttps://hermeticor.com/v1/sites/{id}/allowlist

Parameters

idstringpathrequired

Request body

application/json

originsstring[]

= []

ipsstring[]

= []

{
  "origins": [],
  "ips": []
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/sites/{id}/allowlist" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"origins":[],"ips":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/sites/{id}/allowlist

4XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

5XX Default Response

Same as 4XX · GET /v1/sites/{id}/health

Next part

Updated Nov 8, 2026

Was this page helpful?