Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Registrar Domains API

The Registrar Domains API from APIs.io Engineering Platform — 2 operation(s) for registrar domains.

This API exposes 3 operations across 2 paths, and defines 42 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

3 operations 2 paths 42 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Registrar Domains API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Registrar Domains 3
GET
/accounts/{account_id}/registrar/domains
APIs.io Engineering Platform List domains
registrar-domains-list-domains 1 param → 4XX200
GET
/accounts/{account_id}/registrar/domains/{domain_name}
APIs.io Engineering Platform Get domain
registrar-domains-get-domain 2 params → 4XX200
PUT
/accounts/{account_id}/registrar/domains/{domain_name}
APIs.io Engineering Platform Update domain
registrar-domains-update-domain 2 params body → 4XX200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are registrar-api_contact_properties (13 properties), registrar-api_domain_properties (12 properties), registrar-api_transfer_in (6 properties), registrar-api_api-response-common (4 properties). Each schema is shown below with its type and property counts.

registrar-api_api-response-common
object
4 properties 4 required
registrar-api_contacts
object
registrar-api_api-response-common-failure
object
4 properties 4 required
registrar-api_zipcode
string
The zipcode or postal code where the user lives.
registrar-api_domain_identifier
string
Domain identifier.
registrar-api_organization
string
Name of organization.
registrar-api_created_at
string
Shows time of creation.
registrar-api_first_name
string
User's first name
registrar-api_email
string
The contact email address of the user.
registrar-api_locked
boolean
Shows whether a registrar lock is in place for a domain.
registrar-api_domain_response_single
registrar-api_can_register
boolean
Indicates if the domain can be registered as a new domain.
registrar-api_api-response-single
object
registrar-api_domains
object
registrar-api_supported_tld
boolean
Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of suppor…
registrar-api_city
string
City.
registrar-api_current_registrar
string
Shows name of current registrar.
registrar-api_messages
array
registrar-api_state
string
State.
registrar-api_updated_at
string
Last updated.
registrar-api_country
string
The country in which the user lives.
registrar-api_privacy
boolean
Privacy option controls redacting WHOIS information.
registrar-api_address2
string
Optional address line for unit, floor, suite, etc.
registrar-api_contact_identifier
string
Contact Identifier.
registrar-api_registrant_contact
Shows contact information for domain registrant.
registrar-api_domain_response_collection
registrar-api_telephone
string
User's telephone number
registrar-api_registry_statuses
string
A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-statu…
registrar-api_transfer_in
object
Statuses for domain transfers into Cloudflare Registrar.
6 properties
registrar-api_identifier
string
Identifier
registrar-api_last_name
string
User's last name
registrar-api_available
boolean
Shows if a domain is available for transferring into Cloudflare Registrar.
registrar-api_expires_at
string
Shows when domain name registration expires.
registrar-api_result_info
object
4 properties
registrar-api_auto_renew
boolean
Auto-renew controls whether subscription is automatically renewed upon domain expiration.
registrar-api_fax
string
Contact fax number.
registrar-api_contact_properties
object
13 properties 9 required
registrar-api_domain_name
string
Domain name.
registrar-api_domain_properties
object
12 properties
registrar-api_domain_update_properties
object
3 properties
registrar-api_api-response-collection
object
registrar-api_address
string
Address.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-registrar-domains-api-openapi.yml Raw ↑