registrar

Embed

<a href="https://hermeticor.com/docs/ref-registrar"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/1803a8a0-a5a3-4f6e-9ad9-37c9a48191c7/social-card.svg?v=3e7ae33eec8b" alt="registrar" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/registrar/accounts

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "provider": "string",
      "name": "string",
      "sandbox": true,
      "clientIp": "string",
      "contactEmail": "string",
      "status": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem24[]required

Show child parameters

idstringrequired

providerstringrequired

namestringrequired

sandboxbooleanrequired

clientIpstringrequired

contactEmailstringrequired

statusstringrequired

createdAtstringrequired

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/registrar/accounts

POSThttps://hermeticor.com/v1/registrar/accounts

Connect a Namecheap account (the server IP must be whitelisted in Namecheap API access)

Request body

application/json

providerstringrequired

namecheap

namestringrequired

apiUserstringrequired

apiKeystringrequired

userNamestring

clientIpstringrequired

sandboxboolean

= false

contactobjectrequired

Show child parameters

firstNamestringrequired

lastNamestringrequired

organizationstring

address1stringrequired

citystringrequired

stateProvincestringrequired

postalCodestringrequired

countrystringrequired

phonestringrequired

emailstringrequired

{
  "provider": "namecheap",
  "name": "string",
  "apiUser": "string",
  "apiKey": "string",
  "userName": "string",
  "clientIp": "string",
  "sandbox": false,
  "contact": {
    "firstName": "string",
    "lastName": "string",
    "organization": "string",
    "address1": "string",
    "city": "string",
    "stateProvince": "string",
    "postalCode": "string",
    "country": "string",
    "phone": "string",
    "email": "string"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/registrar/accounts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"namecheap","name":"string","apiUser":"string","apiKey":"string","userName":"string","clientIp":"string","sandbox":false,"contact":{"firstName":"string","lastName":"string","organization":"string","address1":"string","city":"string","stateProvince":"string","postalCode":"string","country":"string","phone":"string","email":"string"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "provider": "string",
  "name": "string",
  "sandbox": true,
  "clientIp": "string",
  "contactEmail": "string",
  "status": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

providerstringrequired

namestringrequired

sandboxbooleanrequired

clientIpstringrequired

contactEmailstringrequired

statusstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/registrar/accounts

5XX Default Response

Same as 4XX · GET /v1/registrar/accounts

DELETEhttps://hermeticor.com/v1/registrar/accounts/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/registrar/accounts/{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/registrar/accounts

5XX Default Response

Same as 4XX · GET /v1/registrar/accounts

GEThttps://hermeticor.com/v1/registrar/search

Availability and one-year price for a name across extensions

Parameters

accountIdstringqueryrequired

qstringqueryrequired

tldsstringquery

= com,net,org,io,co

similarstringquery

true | false = false

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/registrar/search?accountId=<accountId>&q=<q>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "domain": "string",
      "available": true,
      "premium": true,
      "price": "string",
      "currency": "string",
      "canBuy": true,
      "suggestion": false
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

domainstringrequired

availablebooleanrequired

premiumbooleanrequired

pricestringrequired

currencystringrequired

canBuybooleanrequired

suggestionbooleanrequired

= false

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/registrar/accounts

5XX Default Response

Same as 4XX · GET /v1/registrar/accounts

POSThttps://hermeticor.com/v1/registrar/purchase

Buy a domain for one year. confirmPrice must match the price quoted at this moment or nothing is bought

Request body

application/json

purchaseIdstringrequired

accountIdstringrequired

domainstringrequired

confirmPricestringrequired

confirmCurrencystringrequired

{
  "purchaseId": "string",
  "accountId": "string",
  "domain": "string",
  "confirmPrice": "string",
  "confirmCurrency": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/registrar/purchase" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"purchaseId":"string","accountId":"string","domain":"string","confirmPrice":"string","confirmCurrency":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "accountId": "string",
  "domain": "string",
  "status": "string",
  "chargedAmount": "string",
  "currency": "string",
  "orderId": "string",
  "registeredAt": "2024-01-01T00:00:00Z",
  "forwarding": {
    "emails": [
      {
        "mailbox": "string",
        "forwardTo": "string"
      }
    ],
    "redirects": [
      {
        "host": "@",
        "url": "string",
        "permanent": true
      }
    ]
  }
}

Schema

idstringrequired

accountIdstringrequired

domainstringrequired

statusstringrequired

chargedAmountstringrequired

currencystringrequired

orderIdstringrequired

registeredAtstringrequired

forwardingobjectrequired

Show child parameters

emailsEmailsItem[]required

Show child parameters

mailboxstringrequired

forwardTostringrequired

redirectsRedirectsItem[]required

Show child parameters

hoststringrequired

@ | www

urlstringrequired

permanentbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/registrar/accounts

5XX Default Response

Same as 4XX · GET /v1/registrar/accounts

GEThttps://hermeticor.com/v1/registrar/domains

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "accountId": "string",
      "domain": "string",
      "status": "string",
      "chargedAmount": "string",
      "currency": "string",
      "orderId": "string",
      "registeredAt": "2024-01-01T00:00:00Z",
      "forwarding": {
        "emails": [
          {
            "mailbox": "string",
            "forwardTo": "string"
          }
        ],
        "redirects": [
          {
            "host": "@",
            "url": "string",
            "permanent": true
          }
        ]
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsPostV1RegistrarPurchaseResponse[]required

Show child parameters

idstringrequired

accountIdstringrequired

domainstringrequired

statusstringrequired

chargedAmountstringrequired

currencystringrequired

orderIdstringrequired

registeredAtstringrequired

forwardingobjectrequired

Show child parameters

emailsEmailsItem[]required

redirectsRedirectsItem[]required

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/registrar/accounts

5XX Default Response

Same as 4XX · GET /v1/registrar/accounts

PUThttps://hermeticor.com/v1/registrar/domains/{id}/forwarding

Replace the email forwarding rules and the apex/www redirects

Parameters

idstringpathrequired

Request body

application/json

emailsobject[]required

Show child parameters

mailboxstringrequired

forwardTostringrequired

redirectsobject[]required

Show child parameters

hoststringrequired

@ | www

urlstringrequired

permanentbooleanrequired

{
  "emails": [
    {
      "mailbox": "string",
      "forwardTo": "string"
    }
  ],
  "redirects": [
    {
      "host": "@",
      "url": "string",
      "permanent": true
    }
  ]
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/registrar/domains/{id}/forwarding" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[{"mailbox":"string","forwardTo":"string"}],"redirects":[{"host":"@","url":"string","permanent":true}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/registrar/purchase

4XX Default Response

Same as 4XX · GET /v1/registrar/accounts

5XX Default Response

Same as 4XX · GET /v1/registrar/accounts

Next part

Updated Nov 8, 2026

Was this page helpful?