Domain Activity & Notices

Download schema

Endpoints for viewing domain activity and managing notices.

List domain activity

GET

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

/domains/{domainNameOrId}/activity

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all domain activities for a single domain for the authenticated team.

List domain activity › path Parameters

domainNameOrId

string · required

List domain activity › query Parameters

expand[]

string[]

Expand related resources.

Enum values:

domain

domain.tld

domain.contacts

event

string[] · style: form

Filter by one or more events. Separate multiple events with commas.

Enum values:

domain.registration.requested

domain.registration.request_cancelled

domain.registration.succeeded

domain.registration.failed

domain.registration.retry_requested

domain.transfer.incoming.requested

domain.transfer.incoming.request_cancelled

domain.transfer.incoming.succeeded

sort

string[] · maxItems: 5 · style: form

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

Enum values:

-id

created_at

-created_at

Default: ["-created_at"]

cursor

string

Cursor for pagination.

Default: null

per_page

integer · min: 1 · max: 100

Default: 50

List domain activity › Responses

Paginated set of DomainActivity

DomainActivity[] · required

object · required

GET/domains/{domainNameOrId}/activity

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

Example Responses

{
  "data": [
    {
      "id": "id",
      "event": "event",
      "description": "description",
      "causer": {
        "id": "id",
        "type": "type",
        "name": "name"
      },
      "subject": {
        "id": "id",
        "type": "type",
        "name": "name",
        "permalink": "permalink"
      },
      "properties": {
        "price": 0,
        "premium": true,
        "registry_message": "registry_message",
        "cause": {
          "code": "code",
          "message": "message"
        },
        "operation_id": "operation_id",
        "rollback": true,
        "old": {
          "key": {}
        },
        "new": {
          "key": {}
        }
      },
      "created_at": "2024-08-25T15:00:00Z",
      "domain": {
        "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"
        }
      },
      "cursor": "cursor"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "path": "path",
    "per_page": 0,
    "next_cursor": "next_cursor",
    "prev_cursor": "prev_cursor"
  }
}

json

application/json

Dismiss a failed-update notice

POST

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

/domains/{domainNameOrId}/operations/{operationId}/dismiss

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Hide a failed domain-update notice for the whole team after deciding not to correct it. The failed attempt remains available in domain activity.

Dismiss a failed-update notice › path Parameters

domainNameOrId

string · required

full domain name or ID

operationId

string · required

operation ID supplied in the notice data

Dismiss a failed-update notice › Responses

DomainWithNotices

DomainWithNotices · required

POST/domains/{domainNameOrId}/operations/{operationId}/dismiss

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/operations/:operationId/dismiss \
  --request POST \
  --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

Domain Transfers DNS