Domain API

https://api.gandi.net/v5/domain

Gandi Domain Management API

Introduction

This section of our documentation will assist you in the management of domain names at Gandi.net through our REST API.

Documentation on our XML-RPC API can be found at https://doc.rpc.gandi.net

For managing Gandi's LiveDNS via our REST API, please refer to our LiveDNS documentation at:
https://api.gandi.net/docs/livedns/

General information on Gandi's domain name services can be found in our public documentation at:
https://docs.gandi.net/en/domain_names

Domain Change Owner

https://api.gandi.net/v5/domain/changeowner/{domain}

post Initiate a change owner

get Change Owner followup.

Resend the change owner FOA emails

https://api.gandi.net/v5/domain/changeowner/{domain}/foa

post Resend the change owner FOA emails

Domain Availability

https://api.gandi.net/v5/domain/check

get Domain availability

Domain Create and List

https://api.gandi.net/v5/domain/domains

get List domains

post Create a new domain

Domain Information

https://api.gandi.net/v5/domain/domains/{domain}

delete Domain delete

get Domain details

Authorization code management

https://api.gandi.net/v5/domain/domains/{domain}/authinfo

put Reset of authorization code

Domain Automatic Renewal

https://api.gandi.net/v5/domain/domains/{domain}/autorenew

patch Edit autorenew status

Domain claims information

https://api.gandi.net/v5/domain/domains/{domain}/claims

Retrieve potential trademark information related to this domain name. This route should be used before ordering a new domain that is in the first 90 days of its launch.

In case a claims exist must show a notice to your final customer, notifiying him that the name in question is a registered trademak and that the owner(s) of that trademark will be notified and may take legal action

get Retrieve potential trademark information

post Accept a previously retrieved claims

Domain Contacts

https://api.gandi.net/v5/domain/domains/{domain}/contacts

get Domain contact list

patch Domain contact update

Domain Owner

https://api.gandi.net/v5/domain/domains/{domain}/contacts/owner

put Edit domain owner

Domain Creation Status

https://api.gandi.net/v5/domain/domains/{domain}/createstatus

get Domain Creation Status

DNSSEC Keys Management

https://api.gandi.net/v5/domain/domains/{domain}/dnskeys

The following routes let you manage DNSSEC on a domain by sending the DNS public keys to the domain registry. Please read our documentation about DNSSEC before going further.

get DNS Key List

post Create a new DNS Key

put Replace keys on this domain

DNSSEC Key deletion

https://api.gandi.net/v5/domain/domains/{domain}/dnskeys/{id}

delete Delete a DNSSEC Key

Glue Record Management

https://api.gandi.net/v5/domain/domains/{domain}/hosts

A glue record is the association of a hostname with an IP address at the registry. Once created, add your new names to your list of nameservers. Changes will be effective within from 12 up to 72 hours, the time for the DNS new zones to propagate worldwide.

Learn more.

Warning An empty hostname (meaning the glue record is the domain name) is represented here by the name '@'. To allow REST operations on URL …/hosts/@

get Glue record list

post Create a new glue record

Glue record information

https://api.gandi.net/v5/domain/domains/{domain}/hosts/{name}

get Glue record information

put Update a glue record

delete Delete a glue record

LiveDNS Management

https://api.gandi.net/v5/domain/domains/{domain}/livedns

get Domain LiveDNS Information

post Enable LiveDNS

Nameservers Management

https://api.gandi.net/v5/domain/domains/{domain}/nameservers

get Domain Nameserver Information

put Update Domain Nameserver List

Resend reachability email

https://api.gandi.net/v5/domain/domains/{domain}/reachability

patch Resend reachability email

Domain Renewal

https://api.gandi.net/v5/domain/domains/{domain}/renew

get Domain renewal information

post Renew a Domain

Domain Restore

https://api.gandi.net/v5/domain/domains/{domain}/restore

get Domain restore information

post Restore a Domain

Transfer lock status

https://api.gandi.net/v5/domain/domains/{domain}/status

patch Transfer lock/unlock

Manage domain tags

https://api.gandi.net/v5/domain/domains/{domain}/tags

get Get the list of tags linked to a domain

post Attach a new tag to the domain

put Update all the tags of the domain

patch Update some of the tags of the domain

delete Remove all tags from this domain

Domain transfer to another registrar

https://api.gandi.net/v5/domain/domains/{domain}/transferout

post Accept or decline a transfer to another registrar

Web redirections

https://api.gandi.net/v5/domain/domains/{domain}/webredirs

get List web redirections

post Create a new web redirection

Web redirection information

https://api.gandi.net/v5/domain/domains/{domain}/webredirs/{host}

get Get web redirection information

patch Update a redirection

delete Delete a redirection

List Available TLD Extensions

https://api.gandi.net/v5/domain/tlds

get List available TLD extensions

TLD Information

https://api.gandi.net/v5/domain/tlds/{name}

get TLD Details

Domain transfer operations

https://api.gandi.net/v5/domain/transferin

The following routes are used to manage a domain's transfer to Gandi. You may read the main documentation where you'll find tips and special procedures for certain extensions.

post Transfer a domain to Gandi

Domain transfer followup

https://api.gandi.net/v5/domain/transferin/{domain}

get Get transfer status

put Relaunch transfer process

Update authinfo

https://api.gandi.net/v5/domain/transferin/{domain}/authinfo

put Update authinfo code of a pending transfer

Check transfer availability

https://api.gandi.net/v5/domain/transferin/{domain}/available

post Check transfer availability

Resend the transfer FOA emails

https://api.gandi.net/v5/domain/transferin/{domain}/foa

post Resend the transfer FOA emails

Appendix

Domain Extra Parameters

Contact Extra Parameters

Country Codes