Domains

Download schema

Endpoints for managing domains.

List domains

GET

https://domain.chief.app/api/v1

/domains

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all domains for the authenticated team.

List domains › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

contacts

notices

query

string · minLength: 1

Search query.

status

string · enum

Filter by domain status.

Enum values:

active

failed

deleted

requested

pending_payment

scheduled

restorable

restriction

Filter by active registry restriction. Use any for domains with any restriction, or a restriction type such as suspended.

sort

string[] · maxItems: 5 · style: form

Sort by up to five fields, separated by commas. Prefix a field with - for descending order.

Enum values:

name

-name

domain

-domain

tld

-tld

renews_at

-renews_at

Default: ["id"]

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 50

object

Search metadata key-value pairs. Only exact matches are supported.

List domains › Responses

Paginated set of Domain

Domain[] · required

object · required

GET/domains

curl https://domain.chief.app/api/v1/domains \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "example",
      "tld": "com",
      "domain": "example.nl",
      "unicode_domain": "example.nl",
      "type": "type",
      "status": "status",
      "is_premium": true,
      "is_locked": true,
      "is_autorenew_enabled": true,
      "is_whois_privacy_enabled": true,
      "is_using_hosted_dns": true,
      "is_dnssec_enabled": true,
      "contacts": {
        "owner": "CHIEF-CT0000-NL",
        "admin": "CHIEF-CT0000-NL",
        "tech": "CHIEF-CT0000-NL"
      },
      "dnssec_keys": [
        {
          "public_key": "public_key",
          "algorithm": 0,
          "flags": 0,
          "protocol": 3
        }
      ],
      "nameservers": [
        {
          "hostname": "hostname",
          "ipv4": "ipv4",
          "ipv6": "ipv6"
        }
      ],
      "nameserver_provider": "nameserver_provider",
      "intended_use": "intended_use",
      "renews_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "renewal_price": 826,
      "mail_forward_status": "mail_forward_status",
      "mail_forward_renews_at": "2024-08-25T15:00:00Z",
      "scheduled_transfer_at": "2024-08-25T15:00:00Z",
      "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
      "notices": [
        {
          "code": "code",
          "type": "type",
          "severity": "severity",
          "message": "message",
          "actions": [
            "string"
          ],
          "data": {
            "attribute": "string",
            "attributes": [
              "string"
            ],
            "cause": "string",
            "contact_verification_context": "string",
            "operation": "string",
            "renewal_years": 0,
            "renewal_price": 0,
            "resulting_expires_at": "resulting_expires_at",
            "contact_verification_url": "https://www.example.com/path/to/resource",
            "registrar_tag": "registrar_tag",
            "restorable_until": "2024-08-25T15:00:00Z",
            "scheduled_transfer_at": "2024-08-25T15:00:00Z",
            "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
            "auto_completes_at": "2024-08-25T15:00:00Z",
            "requires_intended_use": true,
            "registry_restriction_reason": "string",
            "registry_restriction_detail": "registry_restriction_detail",
            "restricted_since": "2024-08-25T15:00:00Z",
            "suspension_scheduled_at": "2024-08-25T15:00:00Z",
            "operation_id": "operation_id"
          }
        }
      ],
      "registry_restrictions": [
        {
          "type": "type",
          "reason": "reason",
          "detail": "detail",
          "effective_at": "2024-08-25T15:00:00Z",
          "since": "2024-08-25T15:00:00Z"
        }
      ],
      "metadata": {
        "key": "string"
      }
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

List specific domains

POST

https://domain.chief.app/api/v1

/domains/list

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Retrieve up to 100 domains by name or ID. Results preserve the requested order, but domains that do not exist or are not accessible to the authenticated team are omitted. Use expand[]=notices to include each domain's current notices.

List specific domains › Request Body

domains

string[] · minItems: 1 · maxItems: 100 · required

List of domain names or IDs to retrieve.

expand

string[]

Expand related resources.

Enum values:

tld

contacts

notices

List specific domains › Responses

Array of Domain

Domain[] · required

POST/domains/list

curl https://domain.chief.app/api/v1/domains/list \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "expand": [
    "tld"
  ],
  "domains": [
    "string"
  ]
}'

Example Request Body

{
  "expand": [
    "tld"
  ],
  "domains": [
    "string"
  ]
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "example",
      "tld": "com",
      "domain": "example.nl",
      "unicode_domain": "example.nl",
      "type": "type",
      "status": "status",
      "is_premium": true,
      "is_locked": true,
      "is_autorenew_enabled": true,
      "is_whois_privacy_enabled": true,
      "is_using_hosted_dns": true,
      "is_dnssec_enabled": true,
      "contacts": {
        "owner": "CHIEF-CT0000-NL",
        "admin": "CHIEF-CT0000-NL",
        "tech": "CHIEF-CT0000-NL"
      },
      "dnssec_keys": [
        {
          "public_key": "public_key",
          "algorithm": 0,
          "flags": 0,
          "protocol": 3
        }
      ],
      "nameservers": [
        {
          "hostname": "hostname",
          "ipv4": "ipv4",
          "ipv6": "ipv6"
        }
      ],
      "nameserver_provider": "nameserver_provider",
      "intended_use": "intended_use",
      "renews_at": "2024-08-25T15:00:00Z",
      "expires_at": "2024-08-25T15:00:00Z",
      "renewal_price": 826,
      "mail_forward_status": "mail_forward_status",
      "mail_forward_renews_at": "2024-08-25T15:00:00Z",
      "scheduled_transfer_at": "2024-08-25T15:00:00Z",
      "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
      "notices": [
        {
          "code": "code",
          "type": "type",
          "severity": "severity",
          "message": "message",
          "actions": [
            "string"
          ],
          "data": {
            "attribute": "string",
            "attributes": [
              "string"
            ],
            "cause": "string",
            "contact_verification_context": "string",
            "operation": "string",
            "renewal_years": 0,
            "renewal_price": 0,
            "resulting_expires_at": "resulting_expires_at",
            "contact_verification_url": "https://www.example.com/path/to/resource",
            "registrar_tag": "registrar_tag",
            "restorable_until": "2024-08-25T15:00:00Z",
            "scheduled_transfer_at": "2024-08-25T15:00:00Z",
            "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
            "auto_completes_at": "2024-08-25T15:00:00Z",
            "requires_intended_use": true,
            "registry_restriction_reason": "string",
            "registry_restriction_detail": "registry_restriction_detail",
            "restricted_since": "2024-08-25T15:00:00Z",
            "suspension_scheduled_at": "2024-08-25T15:00:00Z",
            "operation_id": "operation_id"
          }
        }
      ],
      "registry_restrictions": [
        {
          "type": "type",
          "reason": "reason",
          "detail": "detail",
          "effective_at": "2024-08-25T15:00:00Z",
          "since": "2024-08-25T15:00:00Z"
        }
      ],
      "metadata": {
        "key": "string"
      }
    }
  ]
}

json

application/json

Show domain

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show a single domain for the authenticated team.

Show domain › path Parameters

domainNameOrId

string · required

full domain name or ID

Show domain › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

contacts

Show domain › Responses

DomainWithNotices

DomainWithNotices · required

GET/domains/{domainNameOrId}

curl https://domain.chief.app/api/v1/domains/:domainNameOrId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Update a domain

PATCH

https://domain.chief.app/api/v1

/domains/{domainNameOrId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Update properties of a single domain for the authenticated team.

Only the properties that are provided will be updated. If you omit a property it will not be changed.

Update a domain › path Parameters

domainNameOrId

string · required

full domain name or ID

Update a domain › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

tld

contacts

Update a domain › Request Body

is_locked

boolean

Lock or unlock the domain. If the domain is locked, it cannot be transferred to another registrar. Note that not all domains support locking. If the domain does not support locking, the request will be rejected. Check the is_lockable property on the domain to see if it supports locking.

is_using_hosted_dns

boolean

Enable hosted DNS, or disable it to revert to the default nameservers. When disabling hosted DNS you may also provide custom nameservers.

is_autorenew_enabled

boolean

Enabled or disables auto-renewal for the domain.

is_dnssec_enabled

boolean

Can be used to disable DNSSEC for the domain. If you want to enable DNSSEC use dnssec_keys and provide at least one key.

is_whois_privacy_enabled

boolean

Enable or disable WHOIS privacy for the domain. This is not supported by all TLDs, check supports_whois_privacy first before setting this attribute. If you disable WHOIS privacy the team's default contacts will be used for all handle types. Alternatively, you can provide contacts to set custom contacts for the domain which will also disable WHOIS privacy.

Cannot be provided together with contacts.

object

Map of contacts for the domain. Only the provided contact types will be updated, any omitted contact types will remain unchanged. When you provide contact handles that are not supported by the TLD they will be ignored.

If you want to reset all contacts to the team's default provide an empty object.

If WHOIS privacy is enabled for the domain it will be disabled.

Cannot be provided together with is_whois_privacy_enabled.

object[]

Enable or disable DNSSEC for the domain. This is not supported by all TLDs, check supports_dnssec first before setting this attribute. If you enable DNSSEC you need to provide at least one DNSSEC key. To disable DNSSEC provide an empty array.

Cannot be provided together with is_dnssec_enabled.

array | null · minItems: 2 · maxItems: 8

Custom nameservers to use when hosted DNS is disabled. You need to provide at least two nameservers.

object

Optional metadata to attach to the domain. Metadata keys must be strings and cannot exceed 40 characters or contain [ or ] characters. Keys starting with domainchief: are read-only system metadata: they may be returned in responses, but are ignored in write requests and do not count towards the 50 key limit. Metadata values must be strings and cannot exceed 500 characters. A domain cannot have more than 50 metadata keys.

To remove a metadata key, set its value to an empty string. To remove all metadata, set the metadata field to an empty object: {}.

Example: {"key1":"value1","key2":"value2"}

Update a domain › Responses

DomainWithNotices

DomainWithNotices · required

PATCH/domains/{domainNameOrId}

curl https://domain.chief.app/api/v1/domains/:domainNameOrId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "is_locked": true,
  "is_using_hosted_dns": true,
  "is_autorenew_enabled": true,
  "is_dnssec_enabled": true,
  "is_whois_privacy_enabled": true,
  "contacts": {
    "owner": "owner",
    "admin": "admin",
    "tech": "tech",
    "billing": "billing",
    "reseller": "reseller"
  },
  "dnssec_keys": [
    {
      "public_key": "public_key",
      "algorithm": 1,
      "flags": 256,
      "protocol": 3
    }
  ],
  "nameservers": [
    {
      "hostname": "ns.domainchief.eu",
      "ipv4": "ipv4",
      "ipv6": "ipv6"
    }
  ],
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}'

Example Request Body

{
  "is_locked": true,
  "is_using_hosted_dns": true,
  "is_autorenew_enabled": true,
  "is_dnssec_enabled": true,
  "is_whois_privacy_enabled": true,
  "contacts": {
    "owner": "owner",
    "admin": "admin",
    "tech": "tech",
    "billing": "billing",
    "reseller": "reseller"
  },
  "dnssec_keys": [
    {
      "public_key": "public_key",
      "algorithm": 1,
      "flags": 256,
      "protocol": 3
    }
  ],
  "nameservers": [
    {
      "hostname": "ns.domainchief.eu",
      "ipv4": "ipv4",
      "ipv6": "ipv6"
    }
  ],
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Delete a domain

DELETE

https://domain.chief.app/api/v1

/domains/{domainNameOrId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Request immediate deletion for a single domain for the authenticated team.

This action may not always be possible to be reversed and may involve extra costs.

Delete a domain › path Parameters

domainNameOrId

string · required

full domain name or ID

Delete a domain › Responses

DomainWithNotices

DomainWithNotices · required

DELETE/domains/{domainNameOrId}

curl https://domain.chief.app/api/v1/domains/:domainNameOrId \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Review domain renewal options

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/renew

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Lists the years that can currently be added to this domain and their total prices. An empty list means manual renewal is unavailable. Prices are in EUR cents excluding VAT.

Review domain renewal options › path Parameters

domainNameOrId

string · required

full domain name or ID

Review domain renewal options › Responses

DomainRenewalQuote

DomainRenewalQuote · required

Request a domain renewal

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/renew

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Confirm one of the options returned by GET /domains/{domainNameOrId}/renew. The domain will renew asynchronously. For prepaid customers, a priced renewal waits for payment through the existing web checkout before it is sent to the registrar; the returned domain notice indicates when payment is required.

This endpoint can create a charge or invoice. The registration term end changes only after the registrar confirms the renewal.

Request a domain renewal › path Parameters

domainNameOrId

string · required

full domain name or ID

Request a domain renewal › Request Body

years

integer · min: 1 · required

Number of whole years to add, chosen from the renewal options.

confirmed_price

integer · min: 0 · required

Total price from the selected option, in EUR cents excluding VAT.

expected_expires_at

string · required

Current registration term end returned by the renewal options endpoint.

Request a domain renewal › Responses

The renewal request was accepted. A priced prepaid renewal waits for payment; other accepted renewals are processed asynchronously.

DomainWithNotices · required

POST/domains/{domainNameOrId}/renew

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/renew \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "years": 1,
  "confirmed_price": 0,
  "expected_expires_at": "expected_expires_at"
}'

Example Request Body

{
  "years": 1,
  "confirmed_price": 0,
  "expected_expires_at": "expected_expires_at"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Restore a domain after confirming its price

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/restore

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Restore a domain after confirming its price › path Parameters

domainNameOrId

string · required

Restore a domain after confirming its price › Request Body

confirmed_price

integer · min: 0 · required

Restore a domain after confirming its price › Responses

DomainWithNotices

DomainWithNotices · required

POST/domains/{domainNameOrId}/restore

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/restore \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "confirmed_price": 0
}'

Example Request Body

{
  "confirmed_price": 0
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Domain Registration