Registrars

Registrars are called domain providers inside the API.

Fields

  • credential_state - Current access token status.
  • credential_state_at - Time of last credential_state change.
  • domains - 0 or more domains manageable using this domain provider.
  • domains_updated_at - Time of last domains refresh.
  • id - DNScaster’s ID for the domain provider, eg: dp_sample123456.
  • in_use - When true, ineligible to be deleted (likely in use by a zone with delegation or glue updates).
  • name - A descriptive name for this domain provider.
  • object - Always domain_provider.
  • provider_name - Registrar’s name
  • provider_type - Registrar type

List domain providers

Query params
  • provider_type - Filter by provider_type.
  • Plus standard paging params.
    • sort - Fields: id (default), name.
Request
GET /v1/domain_providers
Response

On success, 200 with 0 or more domain providers.

{
  "collection": [
    {
      "credential_state": "valid",
      "credential_state_at": 1640995200,
      "domains": [
        "example.com",
        "example.org"
      ],
      "domains_updated_at": 1640995200,
      "id": "dp_sample123456",
      "name": "Name.com",
      "object": "domain_provider",
      "provider_name": "Name.com",
      "provider_type": "namecom"
    }
  ],
  "more_results": false
}

Retrieve a domain provider

Request
GET /v1/domain_providers/dp_sample123456
Response

On success, 200 with the domain provider.

{
  "credential_state": "valid",
  "credential_state_at": 1640995200,
  "domains": [
    "example.com",
    "example.org"
  ],
  "domains_updated_at": 1640995200,
  "id": "dp_sample123456",
  "in_use": false,
  "name": "Name.com",
  "object": "domain_provider",
  "provider_name": "Name.com",
  "provider_type": "namecom"
}