Domain API
https://api.gandi.net/v5/domain
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 ¶
This route is used to start a domain ownership change. Keep in mind that this is not always a free operation. Please check pricing before launching this operation and ensure your prepaid account has enough credit.
Warning: For domain, that is part of Website Pack subscription. Changing the owner will remove the domain name from the subscription. Completing this action during the two months following domain creation will result in your Website Pack being split and the domain being made unavailable. Your hosting subscription will continue as a monthly payment. You can stop your hosting subscription at any time.
URI Parameters
- domain string
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Dry-Run integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization string
Body
application/json
objectWith the following properties:
Required
- owner object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody", "reseller"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not "individual".
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
Optional
- admin object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody", "reseller"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not "individual".
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- bill object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody", "reseller"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not "individual".
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- tech object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody", "reseller"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not "individual".
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
Example:{ "owner": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "state": "FR-IDF", "type": "individual", "email": "alice@example.org" } }
- owner object
200
Dry-Run: 1
header.Headers
Optional
- Warning stringWarning message
- Warning string
Body
application/json
objectWith the following properties:
- status string
One of: "success", "error"
Response status.
Optional
- errors arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description stringError message.
- location string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name stringThe xpath of the field.
- description string
- object
- status string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
get Change Owner followup. ¶
URI Parameters
- domain string
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- created_at datetime
- params object
With the following properties:
Optional
- answer_new_owner string
- answer_old_owner string
- inner_step string
- new_owner_email string
- old_admin_email string
- old_owner_email string
- step string
- step_nb integer
- updated_at datetime
Optional
- date_start string
- errortype string
- errortype_label string
- foa array
Of items of type:
- object
With the following properties:
- answer string
- email string
- object
- inner_step string
Example:{ "created_at": "2021-01-20T00:00:00Z", "updated_at": "2021-01-20T00:00:00Z", "inner_step": "checking_foa_response", "step": "WAIT", "step_nb": 2, "params": { "answer_new_owner": "T", "answer_old_owner": "T", "inner_step": "checking_foa_response", "new_owner_email": "alice@example.org", "old_owner_email": "john@doe.com" } }
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Resend the change owner FOA emails ¶
https://api.gandi.net/v5/domain/changeowner/{domain}/foa
post Resend the change owner FOA emails ¶
URI Parameters
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- email string
Example:{ "email": "alice@example.org" }
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Availability ¶
https://api.gandi.net/v5/domain/check
get Domain availability ¶
Query String
Required
- name stringdomain name to query
Optional
- country stringISO country code for which taxes are to be applied
- currency stringrequest price for a specific ISO currency code
- duration_unit stringdefine the unit for max_duration
- extension stringquery a specific extension for product options
- grid stringrequest price for a specific rate
- lang stringlanguage code
- max_duration integerset a limit on the duration range for returned prices
- period stringspecific registration period to query
- processes array[ string ]
Default: ["create"]
list of at least 1 process for which pricing is to be made - sharing_id stringOrganization for which the pricing is to be made. See the reference.
- name string
?name=example.com
?name=example.com&processes=create&processes=transfer&grid=C
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- currency string
- grid string
- products array
Of items of type:
- object
With the following properties:
- name stringproduct name
- prices array
Of items of type:
- object
With the following properties:
- duration_unit stringtime unit for duration
- max_duration integermaximum duration for which this price unit applies
- min_duration integerminimum duration for which this price unit applies
- price_after_taxes numberpricing after tax is applied
- price_before_taxes numberpricing before tax is applied
Optional
- discount booleanindicate if a discount is active on this price unit
- normal_price_after_taxes numberpricing after tax is applied, when no discount applies
- normal_price_before_taxes numberpricing before tax is applied, when no discount applies
- options object
With the following properties:
Optional
- period stringregistration period
- period string
- type stringpricing type involved
- duration_unit string
- object
- status string
product availability status. NOTE: This availability status is only relevant when the query is related to "processes=create". Status answer should be ignored when "processes" is set to something else. Possible values are:
available
: Domain name is availableavailable_reserved
: Domain name reserved under special conditionsavailable_preorder
: Domain name can be pre-orderedunavailable
: Domain name is not availableunavailable_premium
: Domain name is not availableunavailable_restricted
: Domain name is not available (forbidden)error_invalid
: Provided value is not a valid domain nameerror_refused
: Service is temporarily downerror_timeout
: Service timed out, try the method again latererror_unknown
: Internal server errorreserved_corporate
: The TLD for the given domain name is reserved for Gandi Corporate Services customerspending
: Result is not yet ready, try the method again latererror_eoi
: The TLD for the given domain name is in an Expression of Interest (EOI) period
- taxes array
Of items of type:
- object
With the following properties:
- name stringname of the tax
- rate numberrate in percent
- type stringtype of tax
- name string
- object
Optional
- periods array
Of items of type:
- object
With the following properties:
- name stringname of the registration period
- starts_at datetimestart of the registration period
Optional
- ends_at datetimeend of the registration period if it's not General Availability (golive)
- name string
- object
- process stringprocess for this price
- name string
- object
- taxes array
Of items of type:
- object
With the following properties:
- name stringname of the tax
- rate numberrate in percent
- type stringtype of tax
- name string
- object
Example - Availability and price for premium domains:{ "currency": "EUR", "grid": "A", "products": [ { "status": "available", "periods": [ { "name": "eap5", "starts_at": "2019-02-25T16:00:00Z", "ends_at": "2020-03-28T15:59:59Z" }, { "name": "golive", "starts_at": "2020-03-28T16:00:00Z" } ], "name": "example.com", "process": "create", "taxes": [ { "type": "service", "rate": 20, "name": "vat" } ], "prices": [ { "max_duration": 1, "duration_unit": "y", "min_duration": 1, "discount": false, "price_after_taxes": 878.44, "price_before_taxes": 732.03, "type": "premium" }, { "max_duration": 1, "duration_unit": "y", "min_duration": 1, "discount": false, "price_after_taxes": 775.12, "price_before_taxes": 645.93, "type": "premium" } ] } ], "taxes": [ { "type": "service", "rate": 20, "name": "vat" } ] }
Example - Availability and price, with processes and price rate:{ "currency": "EUR", "grid": "C", "products": [ { "status": "available", "name": "example.com", "process": "transfer", "taxes": [ { "type": "service", "rate": 20, "name": "vat" } ], "prices": [ { "max_duration": 1, "duration_unit": "y", "min_duration": 1, "discount": false, "price_after_taxes": 7.2, "price_before_taxes": 6 } ] }, { "status": "available", "name": "example.com", "process": "create", "taxes": [ { "type": "service", "rate": 20, "name": "vat" } ], "prices": [ { "max_duration": 2, "duration_unit": "y", "normal_price_after_taxes": 11.04, "min_duration": 1, "discount": true, "price_after_taxes": 5.52, "normal_price_before_taxes": 9.2, "price_before_taxes": 4.6 }, { "max_duration": 10, "duration_unit": "y", "normal_price_after_taxes": 9.38, "min_duration": 3, "discount": true, "price_after_taxes": 4.69, "normal_price_before_taxes": 7.82, "price_before_taxes": 3.91 } ] } ], "taxes": [ { "type": "service", "rate": 20, "name": "vat" } ] }
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Create and List ¶
https://api.gandi.net/v5/domain/domains
get List domains ¶
Query String
Optional
- fqdn stringFilters the list by domain name, with optional patterns.Example:
example.net
Example:example.*
Example:*example.com
- nameserver string
One of: "abc", "livedns", "other"
Used to filter the type of nameservers - page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page. - resellee_id stringFilter the list by resellee_id, from the Organization APIExample:
5a53edc7-b514-416a-98c2-2d477a288eb9
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sort_by string
Default: "fqdn"
Used to specify how you want the results sorted. - tld stringUsed to filter by just the extension.
- fqdn string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Accept stringWhen passed
text/csv
value, this route will return a CSV-formatted response.
- Authorization string
200
Headers
- Total-Count integerTotal number of items.
Optional
- Filtered-Count integerOn a filtered list, this is the number of matching items.
- Link stringLinks to next and last page.
- Total-Count integer
Body
application/json
arrayOf items of type:
- object
With the following properties:
- autorenew booleanAutomatic renewal status. Learn more about automatic renewal.
- dates objectDomain's life cycle dates.
With the following properties:
- registry_created_at datetime
- updated_at datetime
Optional
- authinfo_expires_at datetime
- created_at datetime
- deletes_at datetime
- hold_begins_at datetime
- hold_ends_at datetime
- pending_delete_ends_at datetime
- registry_ends_at datetime
- renew_begins_at datetime
- restore_ends_at datetime
- domain_owner string
- fqdn stringFully qualified domain name, written in its native alphabet (IDN).
- fqdn_unicode stringFully qualified domain name, written in unicode (learn more).
- href stringLink to domain details.
- id stringUUID
- nameserver object
With the following properties:
- current string
Optional
- hosts array[ string ]
- orga_owner string
- owner string
- status array
Of items of type:
- string
One of: "clientHold", "clientUpdateProhibited", "clientTransferProhibited", "clientDeleteProhibited", "clientRenewProhibited", "serverHold", "pendingTransfer", "serverTransferProhibited"
Information on the following domain statuses can be found in our general documentation.
- string
- tld string
Optional
- sharing_id stringUUID
- tags array[ string ]List of tags that have been assigned to the domain name.
- autorenew boolean
Example:[ { "status": [ "clientTransferProhibited" ], "dates": { "created_at": "2019-02-13T11:04:18Z", "registry_created_at": "2019-02-13T10:04:18Z", "registry_ends_at": "2021-02-13T10:04:18Z", "updated_at": "2019-02-25T16:20:49Z" }, "tags": [], "fqdn": "example.net", "id": "ba1167be-2f76-11e9-9dfb-00163ec4cb00", "autorenew": false, "tld": "net", "owner": "alice_doe", "orga_owner": "alice_doe", "domain_owner": "Alice Doe", "nameserver": { "current": "livedns" }, "href": "https://api.test/v5/domain/domains/example.net", "fqdn_unicode": "example.net" }, { "status": [], "dates": { "created_at": "2019-01-15T14:19:59Z", "registry_created_at": "2019-01-15T13:19:58Z", "registry_ends_at": "2020-01-15T13:19:58Z", "updated_at": "2019-01-15T13:30:42Z" }, "tags": [], "fqdn": "example.com", "id": "42927d64-18c8-11e9-b9b5-00163ec4cb00", "autorenew": false, "tld": "fr", "owner": "alice_doe", "orga_owner": "alice_doe", "domain_owner": "Alice Doe", "nameserver": { "current": "livedns" }, "href": "https://api.test/v5/domain/domains/example.com", "fqdn_unicode": "example.com" } ]
- object
text/csv
anyCSV-formatted response.
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Create a new domain ¶
This route is used to register domain names. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.
Pay as an individual
To pay with your user organization (ie: yourself as an individual), just use the regular required parameters. The invoice will be edited with your personal information.
For this to work, you need to:
- use the same first name and last name for the domain name's owner
Pay as another organization
To pay using another organization, you'll need to perform the request with the organization's ID as the sharing_id
query string parameter (see reference). The invoice will be edited using this organization's information.
For this to work, you need to:
- have billing permissions on the organization
- use the same organization name for the domain name's owner
Special case - buy a domain as a reseller organization
Should you want to buy a domain for a customer using a reseller account, you'll need the ID (see reference) of your reseller account and your customer's information for the owner. Then, you'll perform the request with sharing_id=<reseller-id>
in the query string and the owner information in the payload. The invoice will be edited with the reseller organization's information.
For this to work, you need to:
- have billing permissions on the reseller organization
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Dry-Run integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization string
Body
application/json
objectWith the following properties:
Required
- fqdn string
- owner object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
Optional
- admin object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- bill object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- claims stringThe value of the
notice_id
returned by the claims route. Warning Make sure your customer did read the notice information about the trademark owner - currency string
One of: "EUR", "USD", "GBP", "TWD", "CNY"
- duration integer
Minimum: 1
Maximum: 10
- enforce_premium booleanMust be set to true if the domain is a premium domain.
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- lang stringISO-639-2 language code of the domain, required for some IDN domains.
- nameservers array[ string ]List of nameservers. Gandi's LiveDNS nameservers are used if omitted.
- nameservers_ips objectFor glue records only – dictionnary associating a nameserver to a list of IP addresses.Example:
{ "ns1.example.net": [ "203.0.113.1" ], "ns2.example.net": [ "203.0.113.2", "203.0.113.3" ] }
- price number
- resellee_id string
- smd stringContents of a Signed Mark Data file (used for newgtld sunrises,
tld_period
must be sunrise) - tech object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- template_id stringTemplate applied when the process is done. It must be a template ID as you can retrieve it using the Template API.
- tld_period string
One of: "sunrise", "landrush", "eap1", "eap2", "eap3", "eap4", "eap5", "eap6", "eap7", "eap8", "eap9", "golive"
Learn more about new GTLD and Early Access Periods.
Example:{ "fqdn": "example.com", "duration": 5, "owner": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "country": "FR", "streetaddr": "5 rue neuve", "phone": "+33.123456789", "state": "FR-IDF", "type": "individual", "email": "alice@example.org" } }
200
Dry-Run: 1
header.Headers
Optional
- Warning stringWarning message
- Warning string
Body
application/json
objectWith the following properties:
- status string
One of: "success", "error"
Response status.
Optional
- errors arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description stringError message.
- location string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name stringThe xpath of the field.
- description string
- object
- status string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Information ¶
https://api.gandi.net/v5/domain/domains/{domain}
delete Domain delete ¶
Warning: the domain deletion is currently a restricted feature.
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
get Domain details ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- autorenew object
With the following properties:
- href string
Optional
- dates array[ datetime ]
- duration integer
Default: 1
- enabled boolean
Default: false
- org_id stringUUID
- can_tld_lock boolean
- contacts object
With the following properties:
- admin object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- same_as_owner booleanWill be
true
when the contact used is the same as the owner. - streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- bill object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- same_as_owner booleanWill be
true
when the contact used is the same as the owner. - streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- owner object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- tech object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- same_as_owner booleanWill be
true
when the contact used is the same as the owner. - streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- admin object
- dates objectDomain's life cycle dates.
With the following properties:
- registry_created_at datetime
- updated_at datetime
Optional
- authinfo_expires_at datetime
- created_at datetime
- deletes_at datetime
- hold_begins_at datetime
- hold_ends_at datetime
- pending_delete_ends_at datetime
- registry_ends_at datetime
- renew_begins_at datetime
- restore_ends_at datetime
- fqdn stringFully qualified domain name, written in its native alphabet (IDN).
- fqdn_unicode stringFully qualified domain name, written in unicode (learn more).
- href stringLink to domain details.
- nameservers array[ string ]
Minimum items: 1
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
- services arrayList of Gandi services attached to this domain.
Of items of type:
- string
One of: "gandidns", "redirection", "gandimail", "packmail", "dnssec", "blog", "hosting", "paas", "site", "certificate", "gandilivedns", "mailboxv2"
- string
- sharing_space object
With the following properties:
- id stringUUID
- name string
- type string
Optional
- reseller boolean
- sharing_space object
With the following properties:
- id stringUUID
- name string
- id string
- id string
- status array
Of items of type:
- string
One of: "clientHold", "clientUpdateProhibited", "clientTransferProhibited", "clientDeleteProhibited", "clientRenewProhibited", "serverHold", "pendingTransfer", "serverTransferProhibited"
Information on the following domain statuses can be found in our general documentation.
- string
- tld string
Optional
- authinfo string
- id stringDomain ID
- sharing_id stringUUID
- tags array[ string ]List of tags that have been assigned to the domain name.
- trustee_roles array
Of items of type:
- object
With the following properties:
- allow_transferout boolean
- editable boolean
- name string
One of: "owner", "admin", "tech", "bill"
- object
Example:{ "status": [ "clientTransferProhibited" ], "dates": { "created_at": "2019-02-13T11:04:18Z", "deletes_at": "2021-03-30T00:04:18Z", "hold_begins_at": "2021-02-13T10:04:18Z", "hold_ends_at": "2021-03-30T10:04:18Z", "pending_delete_ends_at": "2021-05-04T10:04:18Z", "registry_created_at": "2019-02-13T10:04:18Z", "registry_ends_at": "2021-02-13T10:04:18Z", "renew_begins_at": "2012-01-01T00:00:00Z", "restore_ends_at": "2021-04-29T10:04:18Z", "updated_at": "2019-02-25T16:20:49Z", "authinfo_expires_at": "2020-02-25T16:20:49Z" }, "can_tld_lock": true, "tags": [], "reachability": "done", "nameservers": [ "ns-25-a.gnadi.net", "ns-113-b.gnadi.net", "ns-58-c.gnadi.net" ], "contacts": { "admin": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "same_as_owner": true, "state": "FR-IDF", "type": "individual", "email": "alice@example.org" }, "bill": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "same_as_owner": true, "state": "FR-IDF", "type": "individual", "email": "alice@example.org" }, "tech": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "same_as_owner": true, "state": "FR-IDF", "type": "individual", "email": "alice@example.org" }, "owner": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "state": "FR-IDF", "type": "individual", "email": "alice@example.org" } }, "fqdn": "example.net", "autorenew": { "dates": [ "2021-01-13T09:04:18Z", "2021-01-29T10:04:18Z", "2021-02-12T10:04:18Z" ], "org_id": "fe0b931c-18c5-11e9-b9b5-00163ec4cb00", "duration": 1, "href": "http://api.test/v5/domain/domains/example.net/autorenew", "enabled": false }, "authinfo": "8vyhljvJg+", "sharing_space": { "type": "user", "id": "fe0b931c-18c5-11e9-b9b5-00163ec4cb00", "name": "alice_doe" }, "tld": "net", "services": [ "gandilivedns", "mailboxv2" ], "id": "ba1167be-2f76-11e9-9dfb-00163ec4cb00", "trustee_roles": [], "href": "http://api.test/v5/domain/domains/example.net", "fqdn_unicode": "example.net" }
- autorenew object
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Authorization code management ¶
https://api.gandi.net/v5/domain/domains/{domain}/authinfo
put Reset of authorization code ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Automatic Renewal ¶
https://api.gandi.net/v5/domain/domains/{domain}/autorenew
patch Edit autorenew status ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- enabled boolean
Optional
- duration integer
Default: 1
Minimum: 1
Maximum: 9
- org_id string
Example:{ "duration": 1, "enabled": true }
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
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 ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- claims array
Of items of type:
- object
With the following properties:
- contacts arraymanagers (agents) of the trademark on behalf of the owners
Of items of type:
- objectContact information related to a contact / holder
With the following properties:
Optional
- cc string
- city string
- email string
- fax string
- name string
- org string
- pc string
- phone string
- sp string
- street string
- object
- goods_and_services stringA very long string describing the trademark categories
- holders arrayOwner(s) of the trademark
Of items of type:
- objectContact information related to a contact / holder
With the following properties:
Optional
- cc string
- city string
- email string
- fax string
- name string
- org string
- pc string
- phone string
- sp string
- street string
- object
- jurisdiction_classes array
Of items of type:
- integerList of Nice WIPO class numbers (reference)
- integer
- jurisdiction_country string
Optional
- mark_name string
- contacts array
- object
- created_at string
- expires_at stringWarning each notice is valid for an approximate 48 hours, you will get another value after a few hours
- fqdn string
- fqdn_alabel string
- fqdn_ulabel string
- notice_id stringNotice identifier. This should be sent as the "claims" property to the POST on /domains
- status string
One of: "new", "accepted"
- claims array
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
404
Body
application/josn
anyExpected response when no claim is accociated with this domain
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Accept a previously retrieved claims ¶
You must first make a GET request to retrieve the information.
This route can be used to accept a claim after the domain has been ordered, in case the creation is blockeis blocked due to the precense of a claim
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Contacts ¶
https://api.gandi.net/v5/domain/domains/{domain}/contacts
get Domain contact list ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- admin object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- same_as_owner booleanWill be
true
when the contact used is the same as the owner. - streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- bill object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- same_as_owner booleanWill be
true
when the contact used is the same as the owner. - streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- owner object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- tech object
With the following properties:
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- same_as_owner booleanWill be
true
when the contact used is the same as the owner. - streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- reachability string
One of: "pending", "done", "failed", "deleted", "none"
Learn more about reachability here. - sharing_id string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
Example:{ "admin": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "same_as_owner": true, "state": "FR-IDF", "type": "individual", "email": "alice@example.org" }, "bill": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "same_as_owner": true, "state": "FR-IDF", "type": "individual", "email": "alice@example.org" }, "tech": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "same_as_owner": true, "state": "FR-IDF", "type": "individual", "email": "alice@example.org" }, "owner": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "5 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456789", "state": "FR-IDF", "type": "individual", "email": "alice@example.org" } }
- admin object
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
patch Domain contact update ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Optional
- admin object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- bill object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- owner object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- streetaddr string
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- family stringContact's family name (usualy the lastname)
- fax string
- given stringContact's given name (usualy the firstname)
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- tech object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
Example:{ "admin": { "lang": "en", "city": "Paris", "given": "Bob", "family": "Doe", "zip": "75001", "extra_parameters": {}, "country": "FR", "streetaddr": "8 rue neuve", "data_obfuscated": true, "mail_obfuscated": true, "phone": "+33.123456788", "state": "FR-IDF", "type": "individual", "email": "bob@example.org" } }
- admin object
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Owner ¶
https://api.gandi.net/v5/domain/domains/{domain}/contacts/owner
put Edit domain owner ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Dry-Run integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization string
Body
application/json
objectWith the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- streetaddr string
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- family stringContact's family name (usualy the lastname)
- fax string
- given stringContact's given name (usualy the firstname)
- icann_contract_accept boolean
Default: false
To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules. - jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
200
Dry-Run: 1
header.Headers
Optional
- Warning stringWarning message
- Warning string
Body
application/json
objectWith the following properties:
- status string
One of: "success", "error"
Response status.
Optional
- errors arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description stringError message.
- location string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name stringThe xpath of the field.
- description string
- object
- status string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Creation Status ¶
https://api.gandi.net/v5/domain/domains/{domain}/createstatus
get Domain Creation Status ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- step string
One of: "BILL", "WAIT", "RUN", "SUPPORT", "ERROR"
- step_nb integer
Optional
- errortype string
- errortype_label string
- step string
303
Headers
- Location string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
DNSSEC Keys Management ¶
https://api.gandi.net/v5/domain/domains/{domain}/dnskeys
get DNS Key List ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page.
- page integer
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Headers
- Total-Count integerTotal number of items.
Optional
- Link stringLinks to next and last page.
- Total-Count integer
Body
application/json
arrayOf items of type:
- object
With the following properties:
- algorithm integer
Minimum: 0
Maximum: 255
Algorithm - digest stringKey Digest
- digest_type integer
Minimum: 0
Maximum: 255
Key Digest Type - href stringURL to this DNS Key
- id integerId
- keytag integerKey Tag
- type string
One of: "none", "zsk", "ksk"
Key Type
Optional
- public_key stringPublic Key
- algorithm integer
- object
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Create a new DNS Key ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- algorithm integer
Minimum: 0
Maximum: 255
Algorithm - public_key stringPublic Key
- type string
One of: "none", "zsk", "ksk"
Key Type
Example:{ "algorithm": 13, "type": "zsk", "public_key": "ZhCa3rGLofZcndFN2aVd==" }
- algorithm integer
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
put Replace keys on this domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- keys array
Of items of type:
- object
With the following properties:
Required
- algorithm integer
Minimum: 0
Maximum: 255
Algorithm - public_key stringPublic Key
- type string
One of: "none", "zsk", "ksk"
Key Type
- algorithm integer
- object
Example:{ "keys": [ { "algorithm": 13, "type": "zsk", "public_key": "ZhCa3rGLofZcndFN2aVd==" }, { "algorithm": 13, "type": "ksk", "public_key": "SWF0mbNsQJGzhjbB2jiqTcN9JM3Igg==" } ] }
- keys array
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
DNSSEC Key deletion ¶
https://api.gandi.net/v5/domain/domains/{domain}/dnskeys/{id}
delete Delete a DNSSEC Key ¶
id
in the key list result.URI Parameters
- domain stringDomain name.
- id stringKey ID
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
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.
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 ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page.
- page integer
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Headers
- Total-Count integerTotal number of items.
Optional
- Link stringLinks to next and last page.
- Total-Count integer
Body
application/json
arrayOf items of type:
- object
With the following properties:
- fqdn stringFully qualified domain name, written in its native alphabet (IDN).
- fqdn_unicode stringFully qualified domain name, written in unicode.
- href stringURL to this host's details.
- ips array[ string ]List of this host's registered IP addresses.
- name stringName of this host (FQDN without the domain part).
- fqdn string
Example:[ { "ips": [ "203.0.113.1" ], "name": "ns1", "fqdn": "example.net", "href": "http://api.test/v5/domain/domains/example.net/hosts/ns1", "fqdn_unicode": "example.net" }, { "ips": [ "203.0.113.2" ], "name": "@", "fqdn": "example.net", "href": "http://api.test/v5/domain/domains/example.net/hosts/@", "fqdn_unicode": "example.net" } ]
- object
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Create a new glue record ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page.
- page integer
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- ips array[ string ]List of IP addresses.
- name stringHost name of the glue record.
Example:{ "name": "ns2", "ips": [ "203.0.113.2", "203.0.113.3", "2001:db8:0:0:0:0:0:00ff" ] }
- ips array[ string ]
200
Headers
- Total-Count integerTotal number of items.
Optional
- Link stringLinks to next and last page.
- Total-Count integer
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Glue record information ¶
https://api.gandi.net/v5/domain/domains/{domain}/hosts/{name}
get Glue record information ¶
URI Parameters
- domain stringDomain name.
- name stringHost name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- fqdn stringFully qualified domain name, written in its native alphabet (IDN).
- fqdn_unicode stringFully qualified domain name, written in unicode.
- href stringURL to this host's details.
- ips array[ string ]List of this host's registered IP addresses.
- name stringName of this host (FQDN without the domain part).
Example:{ "ips": [ "203.0.113.1" ], "name": "ns1", "fqdn": "example.net", "href": "http://api.test/v5/domain/domains/example.net/hosts/ns1", "fqdn_unicode": "example.net" }
- fqdn string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
put Update a glue record ¶
URI Parameters
- domain stringDomain name.
- name stringHost name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- ips array[ string ]List of IP addresses.
Example:{ "ips": [ "203.0.113.2", "203.0.113.3", "2001:db8:0:0:0:0:0:00ff" ] }
- ips array[ string ]
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
delete Delete a glue record ¶
URI Parameters
- domain stringDomain name.
- name stringHost name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
LiveDNS Management ¶
https://api.gandi.net/v5/domain/domains/{domain}/livedns
get Domain LiveDNS Information ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- current string
One of: "classic", "livedns", "premium_dns", "other"
Type of nameservers currently set.classic
corresponds to Gandi's classic nameservers,livedns
is for the new, default, Gandi nameservers,premium_dns
indicates the presence of Gandi's Premium DNS nameserver and the corresponding service subscription, andother
is for custom nameservers. - nameservers array[ string ]List of current nameservers.
Optional
- dnssec_available booleanIndicates if DNSSEC may be applied to the domain.
- livednssec_available booleanIndicates if DNSSEC with liveDNS may be applied to this domain.
Example:{ "dnssec_available": true, "livednssec_available": true, "nameservers": [ "ns-190-a.gnadi.net", "ns-193-b.gnadi.net", "ns-143-c.gnadi.net" ], "current": "livedns" }
- current string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Enable LiveDNS ¶
This route is used to apply the correct LiveDNS nameservers for the given domain. It takes no content. If you want to disable LiveDNS, change the nameservers.
Please note that if the domain is on the classic Gandi DNS, this will also perform a copy of all existing records immediately afterwards.
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Nameservers Management ¶
https://api.gandi.net/v5/domain/domains/{domain}/nameservers
get Domain Nameserver Information ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
array[ string ]List of FQDNs.Example - Nameserver list:[ "ns1.example.net", "ns2.example.net" ]
Example - Nameserver list (livedns example):[ "ns-190-a.gnadi.net", "ns-193-b.gnadi.net", "ns-143-c.gnadi.net" ]
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
put Update Domain Nameserver List ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- nameservers array[ string ]List of FQDNs.
Example:{ "nameservers": [ "ns1.example.net", "ns2.example.net" ] }
- nameservers array[ string ]
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Resend reachability email ¶
https://api.gandi.net/v5/domain/domains/{domain}/reachability
patch Resend reachability email ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- action string
One of: "resend"
Example:{ "action": "resend" }
- action string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Renewal ¶
https://api.gandi.net/v5/domain/domains/{domain}/renew
get Domain renewal information ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- begins_at string
- durations array[ integer ]
- maximum integer
- minimum integer
- prohibited boolean
Optional
- ends_at string
- in_renew_period boolean
Example:{ "in_renew_period": true, "durations": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "maximum": 8, "minimum": 1, "prohibited": false, "begins_at": "2012-01-01T00:00:00Z", "ends_at": "2021-03-30T00:00:00Z" }
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Renew a Domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Dry-Run integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization string
Body
application/json
objectWith the following properties:
Optional
- duration integer
Default: 1
Minimum: 1
Maximum: 9
The duration (in years) of the renewal.
Example:{ "duration": 2 }
- duration integer
200
Dry-Run: 1
header.Headers
Optional
- Warning stringWarning message
- Warning string
Body
application/json
objectWith the following properties:
- status string
One of: "success", "error"
Response status.
Optional
- errors arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description stringError message.
- location string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name stringThe xpath of the field.
- description string
- object
- status string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain Restore ¶
https://api.gandi.net/v5/domain/domains/{domain}/restore
get Domain restore information ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- restorable boolean
Optional
- contracts array
Of items of type:
- object
With the following properties:
- id string
- name string
Optional
- href string
- registry_contract_href string
- object
Example:{ "restorable": true }
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Restore a Domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
object
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Transfer lock status ¶
https://api.gandi.net/v5/domain/domains/{domain}/status
patch Transfer lock/unlock ¶
Most extensions have a transfer protection mechanism, that consists of a lock that can be put on the domain. When the transfer lock is enabled, the domain can't be transferred. To unlock : clientTransferProhibited=false. To lock : clientTransferProhibited=true.
Warning: Transferring a domain name consists of entrusting its management to another domain name provider. During this process, an authorization code may be required. By transferring a domain away from Gandi, you will lose products that came with the domain. For example, any GandiMail mailboxes associated with the domain name will no longer work, and all emails will be deleted. When a domain is part of a Website Pack subscription, transferring this domain out will remove the domain from the subscription. Completing this action during the two months following domain creation will result in your Website Pack being split and the domain being made unavailable for a certain period, depending on the rules of the registry. The hosting subscription will continue as a monthly payment, though you can cancel the hosting subscription at any time.
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- clientTransferProhibited boolean
Example:{ "clientTransferProhibited": true }
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Manage domain tags ¶
https://api.gandi.net/v5/domain/domains/{domain}/tags
get Get the list of tags linked to a domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
array[ string ]Example:[ "to renew", "tag 2" ]
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Attach a new tag to the domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- tag string
Example:{ "tag": "to renew" }
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
put Update all the tags of the domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- tags array[ string ]
Example:{ "tags": [ "to renew", "tag 2" ] }
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
patch Update some of the tags of the domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- add array[ string ]
- remove array[ string ]
Example:{ "add": [ "premium", "need website" ], "remove": [ "to renew" ] }
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
delete Remove all tags from this domain ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain transfer to another registrar ¶
https://api.gandi.net/v5/domain/domains/{domain}/transferout
post Accept or decline a transfer to another registrar ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- accept boolean
- authinfo string
Example:{ "authinfo": "xyz5500", "accept": true }
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Web redirections ¶
https://api.gandi.net/v5/domain/domains/{domain}/webredirs
get List web redirections ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page.
- page integer
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Accept stringWhen passed
text/csv
value, this route will return a CSV-formatted response.
- Authorization string
200
Headers
- Total-Count integerTotal number of items.
Optional
- Link stringLinks to next and last page.
- Total-Count integer
Body
application/json
arrayOf items of type:
- object
With the following properties:
- host stringSource hostname (including the domain name)
- type string
One of: "cloak", "http301", "http302"
Type of redirection - url stringTarget URL
Optional
- cert_status string
- cert_uuid string
- created_at string
- protocol string
One of: "http", "https", "httpsonly"
- updated_at string
- host string
- object
text/csv
anyCSV-formatted response.
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
post Create a new web redirection ¶
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page.
- page integer
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- host stringSource hostname (including the domain name)
- override booleanWhen you create a redirection on a domain a DNS record is created if it does not exist. When the record already exists and this parameter is set to
true
it will overwrite the record. Otherwise it will trigger an error. - protocol string
One of: "http", "https", "httpsonly"
- type string
One of: "cloak", "http301", "http302"
Type of redirection - url stringTarget URL
Example:{ "host": "www.example.net", "override": true, "protocol": "https", "type": "http301", "url": "http://www.example.org/" }
- host string
200
Headers
- Total-Count integerTotal number of items.
Optional
- Link stringLinks to next and last page.
- Total-Count integer
201
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Web redirection information ¶
https://api.gandi.net/v5/domain/domains/{domain}/webredirs/{host}
get Get web redirection information ¶
URI Parameters
- domain stringDomain name.
- host stringHost name
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- host stringSource hostname (including the domain name)
- type string
One of: "cloak", "http301", "http302"
Type of redirection - url stringTarget URL
Optional
- cert_status string
- cert_uuid string
- created_at string
- protocol string
One of: "http", "https", "httpsonly"
- updated_at string
- host string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
patch Update a redirection ¶
URI Parameters
- domain stringDomain name.
- host stringHost name
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Optional
- override booleanIf
true
, a DNS record will be created. When the value isfalse
and no matching DNS record exists, it will trigger an error. - protocol string
One of: "http", "https", "httpsonly"
- type string
One of: "cloak", "http301", "http302"
Type of redirection - url stringTarget URL
Example:{ "override": true, "protocol": "http", "type": "http302" }
- override boolean
200
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
delete Delete a redirection ¶
URI Parameters
- domain stringDomain name.
- host stringHost name
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
List Available TLD Extensions ¶
https://api.gandi.net/v5/domain/tlds
get List available TLD extensions ¶
Query String
Optional
- category string
One of: "ccTLD", "gTLD"
Category of the TLD - page integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page integer
Minimum: 1
How many items to display per page.
- category string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Headers
- Total-Count integerTotal number of items.
Optional
- Link stringLinks to next and last page.
- Total-Count integer
Body
application/json
arrayOf items of type:
- object
With the following properties:
- href stringLink to TLD details.
- name stringName of the TLD.
- href string
Example:[ { "name": "com", "href": "https://api.test/v5/domain/tlds/com" }, { "name": "eu", "href": "https://api.test/v5/domain/tlds/eu" }, { "name": "fr", "href": "https://api.test/v5/domain/tlds/fr" }, { "name": "info", "href": "https://api.test/v5/domain/tlds/info" }, { "name": "net", "href": "https://api.test/v5/domain/tlds/net" }, { "name": "org", "href": "https://api.test/v5/domain/tlds/org" } ]
- object
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
TLD Information ¶
https://api.gandi.net/v5/domain/tlds/{name}
get TLD Details ¶
URI Parameters
- name stringName of the TLD, or a FQDN.
- name string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- authinfo_for_transfer boolean
true
if authinfo is required prior to transfer. - category string
One of: "ccTLD", "gTLD"
Category of the TLD. - change_owner boolean
true
if change owner is allowed. - corporate boolean
true
if this is a corporate TLD. - ext_trade boolean
- full_tld string
- href stringLink to TLD details.
- lock boolean
- name stringName of the TLD.
Example:{ "category": "ccTLD", "name": "eu", "lock": false, "change_owner": true, "authinfo_for_transfer": true, "full_tld": "eu", "corporate": false, "ext_trade": true, "href": "https://api.test/v5/domain/tlds/eu" }
- authinfo_for_transfer boolean
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain transfer operations ¶
https://api.gandi.net/v5/domain/transferin
post Transfer a domain to Gandi ¶
This route is used to start transferring a domain to Gandi. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.
Pay as an individual
To pay with your user organization (ie: yourself as an individual), just use the regular required parameters. The invoice will be edited with your personal information.
For this to work, you need to:
- use the same first name and last name for the domain name's owner
Pay as another organization
To pay using another organization, you'll need to perform the request with the organization's ID as the sharing_id
query string parameter (see reference). The invoice will be edited using this organization's information.
For this to work, you need to:
- have billing permissions on the organization
- use the same organization name for the domain name's owner
Special case - transfer a domain as a reseller organization
Should you want to transfer a domain for a customer using a reseller account, you'll need the ID (see reference) of your reseller account and your customer's information for the owner. Then, you'll perform the request with sharing_id=<reseller-id>
in the query string and the owner information in the payload. The invoice will be edited with the reseller organization's information.
For this to work, you need to:
- have billing permissions on the reseller organization
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Dry-Run integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization string
Body
application/json
objectWith the following properties:
Required
- fqdn string
- owner object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
Optional
- admin object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- authinfo string
- bill object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- change_owner boolean
- currency string
One of: "EUR", "USD", "GBP", "TWD", "CNY"
- duration integer
Minimum: 1
Maximum: 10
- enforce_premium booleanMust be set to true if the domain is a premium domain.
- extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- nameservers array[ string ]List of nameservers. Gandi's LiveDNS nameservers are used if omitted.
- nameservers_ips objectFor glue records only – dictionnary associating a nameserver to a list of IP addresses.Example:
{ "ns1.example.net": [ "203.0.113.1" ], "ns2.example.net": [ "203.0.113.2", "203.0.113.3" ] }
- price number
- resellee_id string
- tech object
With the following properties:
Required
- country stringA country code. See the country code list for possible values.
- email string
- family stringContact's family name (usualy the lastname)
- given stringContact's given name (usualy the firstname)
- streetaddr string
- type string
One of: "individual", "company", "association", "publicbody"
Optional
- brand_number string
- city string
- data_obfuscated boolean
Default: true
Learn more about WHOIS privacy at Gandi here. - extra_parameters objectExtra parameters needed for some extensions. See this list for possible values.
- fax string
- jo_announce_number string
- jo_announce_page string
- jo_declaration_date string
- jo_publication_date string
- lang string
One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"
- mail_obfuscated boolean
- mobile string
- orgname stringThe legal name of the company, association, or public body if the contact type is not 0.
- phone string
- siren string
- state stringLearn more about state codes here
- validation string
One of: "pending", "done", "failed", "deleted", "none"
- zip string
- country string
- template_id stringTemplate applied when the process is done. It must be a template ID as you can retrieve it using the Template API.
Example:{ "fqdn": "example.com", "authinfo": "xyz5500", "duration": 2, "owner": { "city": "Paris", "given": "Alice", "family": "Doe", "zip": "75001", "country": "FR", "streetaddr": "5 rue neuve", "phone": "+33.123456789", "state": "FR-IDF", "type": "individual", "email": "alice@example.org" } }
200
Dry-Run: 1
header.Headers
Optional
- Warning stringWarning message
- Warning string
Body
application/json
objectWith the following properties:
- status string
One of: "success", "error"
Response status.
Optional
- errors arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description stringError message.
- location string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name stringThe xpath of the field.
- description string
- object
- status string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Domain transfer followup ¶
https://api.gandi.net/v5/domain/transferin/{domain}
get Get transfer status ¶
step
value is done
.URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
200
Body
application/json
objectWith the following properties:
- created_at string
- owner_contact string
- params object
With the following properties:
- domain string
Optional
- duration integer
- reseller string
- tld string
- version integer
- step string
- step_nb integer
- updated_at string
Optional
- errortype string
- errortype_label string
- foa array
Of items of type:
- object
With the following properties:
- answer string
- email string
- object
- inner_step string
- regac_at string
- start_at string
- transfer_link string
- transfer_procedure string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
put Relaunch transfer process ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
404
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Update authinfo ¶
https://api.gandi.net/v5/domain/transferin/{domain}/authinfo
put Update authinfo code of a pending transfer ¶
This route is used to update the authinfo code of a pending transfer, in case it was not specified or was invalid.
Note that the sharing_id
is needed when trying to change the code for a given organization
URI Parameters
- domain stringDomain name.
- domain string
Query String
Optional
- sharing_id stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- authinfo string
Example:{ "authinfo": ".example!authinfo02" }
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Check transfer availability ¶
https://api.gandi.net/v5/domain/transferin/{domain}/available
post Check transfer availability ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Optional
- authinfo string
Example:{ "authinfo": "xyz5500" }
200
Body
application/json
objectWith the following properties:
- available boolean
- fqdn string
- fqdn_alabel string
- fqdn_ulabel string
Optional
- corporate boolean
- durations array[ integer ]
- internal boolean
- maximum_duration integer
- minimum_duration integer
- msg string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Resend the transfer FOA emails ¶
https://api.gandi.net/v5/domain/transferin/{domain}/foa
post Resend the transfer FOA emails ¶
URI Parameters
- domain stringDomain name.
- domain string
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Body
application/json
objectWith the following properties:
Required
- email string
Example:{ "email": "alice@example.net" }
202
Headers
Optional
- Location string
Body
application/json
objectWith the following properties:
- message stringConfirmation message.
- message string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
401
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
403
Body
application/json
objectWith the following properties:
- cause string
- code integer
- message string
- object string
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization string
Appendix
Domain Extra Parameters ¶
- object
With the following properties:
Optional
- x-aero_ens_authid stringaero id (you can apply for an .aero id on http://www.information.aero/)
- x-aero_ens_authkey stringaero password
- x-au_registrant_id_number string
- x-au_registrant_id_type stringowner's document type
- x-az_admin_pp_id stringID number for a Physical Person admin contact
- x-az_billing_pp_id stringID number for a Physical Person billing contact
- x-az_registrant_company_number stringCompany number for a Moral Person registrant contact
- x-az_registrant_pp_id stringID number for a Physical Person registrant contact
- x-az_tech_pp_id stringID number for a Physical Person tech contact
- x-barcelona_intendeduse stringIntended use for domain name
- x-barcelona_trademarkid stringLocal Trademark ID.
- x-ca_business_entity_type stringbusiness entity type
- x-ca_legaltype stringowner's legal type
- x-ca_official_rep stringofficial representative (for LGR)
- x-ca_official_rep_capacity stringofficial representative capacity (for LGR)
- x-ca_owner_name stringowner name (deprecated)
- x-cat_intendeduse stringIntended use for domain name
- x-coop_sponsor stringCoop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
- x-cy_reg_identity_no stringid card number or passport number if physical person, else registration number (SIREN)
- x-document_country stringRegistrant's country which issued the document
- x-document_type stringRegistrant's document type
- x-document_value stringRegistrant's document number
- x-es_admin_identification stringid of the admin contact
- x-es_admin_tipo_identification stringtype of id for admin
- x-es_bill_identification stringid of the bill contact
- x-es_bill_tipo_identification stringtype of id for bill
- x-es_identification stringid of the contact (deprecated)
- x-es_legalform stringlegal form of the organization (deprecated)
- x-es_owner_identification stringid of the owner contact
- x-es_owner_legalform stringlegal form of the owner organization
- x-es_owner_tipo_identification stringtype of id for owner
- x-es_tech_identification stringid of the tech contact
- x-es_tech_tipo_identification stringtype of id for tech
- x-es_tipo_identification stringtype of id (deprecated)
- x-eu_country_of_citizenship stringCountry of citizenship for registrant
- x-eus_intendeduse stringIntended use for domain name
- x-fi_business_number stringRegistrant's identification number for a moral person
- x-fi_ident_number stringRegistrant's identification number for a physical person
- x-fi_isfinish stringWhether or not domain registrant is Finish, for a physical or moral person
- x-fi_organization_type stringRegistrant organization type for a moral person
- x-gal_intendeduse stringIntended use for domain name
- x-hk_registrant_birth_date stringowner's birth date (YYYY-MM-DD)
- x-hk_registrant_document_number stringnumber of the above document
- x-hk_registrant_document_origin_country stringcountry code (FR, GB, US…) of the origin country of the above document
- x-hk_registrant_document_type stringowner's document type
- x-hk_registrant_other_document_type stringmandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
- x-hr_ident_number stringCroatian identification number (OIB)
- x-hr_non_eu_pm_business_number stringLocal business registration number
- x-hu_idnumber stringid card number or passport number of the physical person
- x-hu_owner_vatid stringvatid of the moral person
- x-ie_registrant_cro_number stringCompanies Registration Office in case the registrant type ie COM
- x-ie_registrant_supporting_number stringIdentifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
- x-ie_registrant_type stringThe contact's Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
- x-il_registrant_company_type string
- x-it_nationality stringnationality of the owner
- x-it_pin stringowner's Italian fiscal code or the number of an identity document
- x-it_registrant_entity_type stringowner entity type
- x-jobs_website stringowner website information (deprecated)
- x-kr_reg_identity_no stringRegistrant's Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
- x-lt_registrant_legal_id stringowner legal entity identification code
- x-ltda_authority stringauthority where the contact is registred
- x-ltda_licensenumber stringlicence number
- x-lv_idnumber stringid card number or passport number if physical person, else registration number (SIREN)
- x-madrid_intendeduse stringIntended use for domain name
- x-my_admin_contact_password stringAdmin contact password record (For transfer only)
- x-my_admin_contact_username stringAdmin contact username as per Whois record (For transfer only)
- x-my_business_number stringRegistrant's Business Number
- x-my_organization_type stringRegistrant's Organization Type
- x-no_registrant_identity stringPersonal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits)
- x-nu_registrant_idnumber stringRegistrant's id number or organization number
- x-nu_registrant_vatid stringvatid of the moral person
- x-nyc_extcontact stringGandi Handle of the EXTContact
- x-pro_authority stringauthority where the contact is registred
- x-pro_authoritywebsite stringlink to the registration authority
- x-pro_licensenumber stringlicence number
- x-pro_profession stringcontact profession
- x-promopixel_company_serial stringowner
- x-pt_arbitration stringtrue (default) or false as answer to whether or not the registry arbitration is accepted
- x-pt_registrant_vatid stringowner's VAT for company or ID card number for individual
- x-pt_roid stringroid of the domain (in transfer process only)
- x-pt_tech_vatid stringtech's VAT for company or ID card number for individual
- x-quebec_intendeduse stringIntended use for domain name
- x-radio_intendeduse stringIntended use for domain name
- x-ro_registrant_idnumber stringid card number or passport number if physical person, else registration number (SIREN)
- x-rs_company_number stringThe company's number for Moral Person.
- x-rs_reg_identity_no stringRegistrant's Residence Registration No. (13-digit)
- x-rs_reg_tax_no stringRegistrant's GST/VAT number
- x-ru_registrant_birth_date stringowner's birth date (YYYY-MM-DD)
- x-ru_registrant_kpp stringTerritory-linked taxpayer number for PM registrants
- x-ru_registrant_passport_data stringThe number of the identity proof
- x-ru_registrant_tin stringTaxpayer identification number for PM registrants
- x-scot_intendeduse stringIntended use for domain name
- x-se_ident_number stringSwedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
- x-se_registrant_vatid stringvatid of the moral person
- x-sg_idnumber stringRegistrant's id number
- x-sport_intendeduse stringIntended use for domain name
- x-srl_authority stringauthority where the contact is registred
- x-srl_licensenumber stringlicence number
- x-swiss_enterpriseid stringSwiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
- x-swiss_intendeduse stringIntended use for domain name
- x-travel_uin stringan Unique Identification Number (deprecated)
- x-tw_company_number stringThe company's number for Moral Person.
- x-uk_co_no stringThe registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
- x-uk_contact_type stringContact type as defined at NOMINET
- x-us_app_purpose stringDomain application purpose
- x-us_nexus_category stringApplicant category
- x-xxx_membership_contact stringowner contact membership ID, obtained on the xxx registry website.
- x-xxx_sponsored_community stringyes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community
- x-aero_ens_authid string
Contact Extra Parameters ¶
- object
With the following properties:
Required
- birth_city stringcontact birth city
- birth_country stringcontact birth country
- birth_date stringcontact birth date (YYYY-MM-DD)
- birth_department stringcontact birth department … or zipcode, use 99 if contact was born outside of France / DOM/TOM
- brand_number stringcompany brand number
- duns stringcontact duns number
- waldec stringcontact waldec number
- x-aero_ens_authid stringaero id (you can apply for an .aero id on http://www.information.aero/)
- x-aero_ens_authkey stringaero password
- x-au_registrant_id_number string
- x-au_registrant_id_type stringowner's document type
- x-az_admin_pp_id stringID number for a Physical Person admin contact
- x-az_billing_pp_id stringID number for a Physical Person billing contact
- x-az_registrant_company_number stringCompany number for a Moral Person registrant contact
- x-az_registrant_pp_id stringID number for a Physical Person registrant contact
- x-az_tech_pp_id stringID number for a Physical Person tech contact
- x-barcelona_intendeduse stringIntended use for domain name
- x-barcelona_trademarkid stringLocal Trademark ID.
- x-ca_business_entity_type stringbusiness entity type
- x-ca_legaltype stringowner's legal type
- x-ca_official_rep stringofficial representative (for LGR)
- x-ca_official_rep_capacity stringofficial representative capacity (for LGR)
- x-ca_owner_name stringowner name (deprecated)
- x-cat_intendeduse stringIntended use for domain name
- x-coop_sponsor stringCoop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
- x-cy_reg_identity_no stringid card number or passport number if physical person, else registration number (SIREN)
- x-document_country stringRegistrant's country which issued the document
- x-document_type stringRegistrant's document type
- x-document_value stringRegistrant's document number
- x-es_admin_identification stringid of the admin contact
- x-es_admin_tipo_identification stringtype of id for admin
- x-es_bill_identification stringid of the bill contact
- x-es_bill_tipo_identification stringtype of id for bill
- x-es_identification stringid of the contact (deprecated)
- x-es_legalform stringlegal form of the organization (deprecated)
- x-es_owner_identification stringid of the owner contact
- x-es_owner_legalform stringlegal form of the owner organization
- x-es_owner_tipo_identification stringtype of id for owner
- x-es_tech_identification stringid of the tech contact
- x-es_tech_tipo_identification stringtype of id for tech
- x-es_tipo_identification stringtype of id (deprecated)
- x-eu_country_of_citizenship stringCountry of citizenship for registrant
- x-eus_intendeduse stringIntended use for domain name
- x-fi_business_number stringRegistrant's identification number for a moral person
- x-fi_ident_number stringRegistrant's identification number for a physical person
- x-fi_isfinish stringWhether or not domain registrant is Finish, for a physical or moral person
- x-fi_organization_type stringRegistrant organization type for a moral person
- x-gal_intendeduse stringIntended use for domain name
- x-hk_registrant_birth_date stringowner's birth date (YYYY-MM-DD)
- x-hk_registrant_document_number stringnumber of the above document
- x-hk_registrant_document_origin_country stringcountry code (FR, GB, US…) of the origin country of the above document
- x-hk_registrant_document_type stringowner's document type
- x-hk_registrant_other_document_type stringmandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
- x-hr_ident_number stringCroatian identification number (OIB)
- x-hr_non_eu_pm_business_number stringLocal business registration number
- x-hu_idnumber stringid card number or passport number of the physical person
- x-hu_owner_vatid stringvatid of the moral person
- x-ie_registrant_cro_number stringCompanies Registration Office in case the registrant type ie COM
- x-ie_registrant_supporting_number stringIdentifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
- x-ie_registrant_type stringThe contact's Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
- x-il_registrant_company_type string
- x-it_nationality stringnationality of the owner
- x-it_pin stringowner's Italian fiscal code or the number of an identity document
- x-it_registrant_entity_type stringowner entity type
- x-jobs_website stringowner website information (deprecated)
- x-kr_reg_identity_no stringRegistrant's Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
- x-lt_registrant_legal_id stringowner legal entity identification code
- x-ltda_authority stringauthority where the contact is registred
- x-ltda_licensenumber stringlicence number
- x-lv_idnumber stringid card number or passport number if physical person, else registration number (SIREN)
- x-madrid_intendeduse stringIntended use for domain name
- x-my_admin_contact_password stringAdmin contact password record (For transfer only)
- x-my_admin_contact_username stringAdmin contact username as per Whois record (For transfer only)
- x-my_business_number stringRegistrant's Business Number
- x-my_organization_type stringRegistrant's Organization Type
- x-no_registrant_identity stringPersonal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits)
- x-nu_registrant_idnumber stringRegistrant's id number or organization number
- x-nu_registrant_vatid stringvatid of the moral person
- x-nyc_extcontact stringGandi Handle of the EXTContact
- x-pro_authority stringauthority where the contact is registred
- x-pro_authoritywebsite stringlink to the registration authority
- x-pro_licensenumber stringlicence number
- x-pro_profession stringcontact profession
- x-promopixel_company_serial stringowner
- x-pt_arbitration stringtrue (default) or false as answer to whether or not the registry arbitration is accepted
- x-pt_registrant_vatid stringowner's VAT for company or ID card number for individual
- x-pt_roid stringroid of the domain (in transfer process only)
- x-pt_tech_vatid stringtech's VAT for company or ID card number for individual
- x-quebec_intendeduse stringIntended use for domain name
- x-radio_intendeduse stringIntended use for domain name
- x-ro_registrant_idnumber stringid card number or passport number if physical person, else registration number (SIREN)
- x-rs_company_number stringThe company's number for Moral Person.
- x-rs_reg_identity_no stringRegistrant's Residence Registration No. (13-digit)
- x-rs_reg_tax_no stringRegistrant's GST/VAT number
- x-ru_registrant_birth_date stringowner's birth date (YYYY-MM-DD)
- x-ru_registrant_kpp stringTerritory-linked taxpayer number for PM registrants
- x-ru_registrant_passport_data stringThe number of the identity proof
- x-ru_registrant_tin stringTaxpayer identification number for PM registrants
- x-scot_intendeduse stringIntended use for domain name
- x-se_ident_number stringSwedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
- x-se_registrant_vatid stringvatid of the moral person
- x-sg_idnumber stringRegistrant's id number
- x-sport_intendeduse stringIntended use for domain name
- x-srl_authority stringauthority where the contact is registred
- x-srl_licensenumber stringlicence number
- x-swiss_enterpriseid stringSwiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
- x-swiss_intendeduse stringIntended use for domain name
- x-travel_uin stringan Unique Identification Number (deprecated)
- x-tw_company_number stringThe company's number for Moral Person.
- x-uk_co_no stringThe registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
- x-uk_contact_type stringContact type as defined at NOMINET
- x-us_app_purpose stringDomain application purpose
- x-us_nexus_category stringApplicant category
- x-xxx_membership_contact stringowner contact membership ID, obtained on the xxx registry website.
- x-xxx_sponsored_community stringyes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community
- birth_city string
Country Codes ¶
Code | Name |
---|---|
AC | Ascension |
AD | Andorra |
AE | United Arab Emirates |
AF | Afghanistan |
AG | Antigua and Barbuda |
AI | Anguilla |
AL | Albania |
AM | Armenia |
AN | Netherlands Antilles |
AO | Angola |
AQ | Antarctica |
AR | Argentina |
AS | American Samoa |
AT | Austria |
AU | Australia |
AW | Aruba |
AX | Aland Islands |
AZ | Azerbaijan |
BA | Bosnia and Herzegovina |
BB | Barbados |
BD | Bangladesh |
BE | Belgium |
BF | Burkina Faso |
BG | Bulgaria |
BH | Bahrain |
BI | Burundi |
BJ | Benin |
BL | Saint Barthelemy |
BM | Bermuda |
BN | Brunei |
BO | Bolivia |
BQ | Bonaire, Sint Eustatius and Saba |
BR | Brazil |
BS | Bahamas |
BT | Bhutan |
BV | Bouvet Island |
BW | Botswana |
BY | Belarus |
BZ | Belize |
CA | Canada |
CC | Islands Cocos (Keeling) Islands |
CD | Congo Zaire |
CF | Central African Republic |
CG | Congo |
CH | Switzerland |
CI | Ivory Coast |
CK | Cook Islands |
CL | Chile |
CM | Cameroon |
CN | China |
CO | Colombia |
CR | Costa Rica |
CU | Cuba |
CV | Cape Verde |
CW | Curacao |
CX | Christmas Island |
CY | Cyprus |
CZ | Czech Republic |
DE | Germany |
DJ | Djibouti |
DK | Denmark |
DM | Dominica |
DO | Dominican (Republic) |
DZ | Algeria |
EC | Ecuador |
EE | Estonia |
EG | Egypt |
EH | Western Sahara |
ER | Erytrea |
ES | Spain |
ET | Ethiopia |
FI | Finland |
FJ | Fiji |
FK | Falkland Islands |
FM | Micronesia |
FO | Faeroe Islands |
FR | France |
GA | Gabon |
GB | United Kingdom |
GD | Grenada |
GE | Georgia |
GF | French Guiana |
GG | Guernsey |
GH | Ghana |
GI | Gibraltar |
GL | Greenland |
GM | Gambia |
GN | Guinea |
GP | Guadeloupe |
GQ | Equatorial Guinea |
GR | Greece |
GS | South Georgia and the South Sandwich Islands |
GT | Guatemala |
GU | Guam |
GW | Guinea-Bissau |
GY | Guyana |
HK | Hong Kong |
HM | Australia Heard Island and McDonald Islands |
HN | Honduras |
HR | Croatia |
HT | Haiti |
HU | Hungary |
ID | Indonesia |
IE | Ireland |
IL | Israel |
IM | Isle of Man |
IN | India |
IO | British Indian Ocean Territory |
IQ | Iraq |
IR | Iran (Islamic Rep. of) |
IS | Iceland |
IT | Italy |
JE | Jersey (Islands) |
JM | Jamaica |
JO | Jordan |
JP | Japan |
KE | Kenya |
KG | Kyrgystan |
KH | Cambodia |
KI | Kiribati |
KM | Comoros |
KN | Saint Kitts and Nevis |
KP | Korea (Democratic People's Republic of) |
KR | Korea (Republic of) |
KW | Kuwait |
KY | Cayman (Islands) |
KZ | Kazakhstan |
LA | Laos (People's Democratic Republic of) |
LB | Lebanon |
LC | Saint Lucia |
LI | Liechstenstein |
LK | Sri Lanka |
LR | Liberia |
LS | Lesotho |
LT | Lithuania |
LU | Luxembourg |
LV | Latvia |
LY | Libya |
MA | Morocco |
MC | Monaco |
MD | Moldova |
ME | Montenegro |
MF | Saint Martin (French Part) |
MG | Madagascar |
MH | Marshall Islands |
MK | Macedonia (F.Y.R.O.M.) |
ML | Mali |
MM | Myanmar |
MN | Mongolia |
MO | Macao |
MP | Saipan |
MQ | Martinique |
MR | Mauritania |
MS | Montserrat |
MT | Malta |
MU | Mauritius |
MV | Maldives |
MW | Malawi |
MX | Mexico |
MY | Malaysia |
MZ | Mozambique |
NA | Namibia |
NC | New Caledonia |
NE | Niger |
NF | Norfolk Island |
NG | Nigeria |
NI | Nicaragua |
NL | Netherlands |
NO | Norway |
NP | Nepal |
NR | Nauru |
NU | Niue |
NZ | New Zealand |
OM | Oman |
PA | Panama |
PE | Peru |
PF | French Polynesia |
PG | Papua New Guinea |
PH | Philippines |
PK | Pakistan |
PL | Poland |
PM | Saint Pierre et Miquelon |
PN | Pitcairn |
PR | Puerto Rico |
PS | Palestine |
PT | Portugal |
PW | Palau |
PY | Paraguay |
QA | Qatar |
RE | Reunion |
RO | Romania |
RS | Serbia |
RU | Russia |
RW | Rwanda |
SA | Saudi Arabia |
SB | Solomon |
SC | Seychelles |
SD | Sudan |
SE | Sweden |
SG | Singapore |
SH | Saint Helena |
SI | Slovenia |
SJ | Svalbard and Jan Mayen |
SK | Slovak (Republic) |
SL | Sierra Leone |
SM | San Marino |
SN | Senegal |
SO | Somalia |
SR | Surinam |
SS | South Sudan |
ST | Sao Tome and Principe |
SV | El Salvador |
SX | Saint Martin (Dutch Part) |
SY | Syria |
SZ | Swaziland |
TC | Turks and Caicos Islands |
TD | Chad |
TF | French Southern Territories |
TG | Togo |
TH | Thailand |
TJ | Tajikistan (Republic of) |
TK | Tokelau |
TL | Timor-Leste |
TM | Turkmenistan |
TN | Tunisia |
TO | Tonga |
TP | East Timor |
TR | Turkey |
TT | Trinidad and Tobago |
TV | Tuvalu |
TW | Taiwan |
TZ | Tanzania |
UA | Ukraine |
UG | Uganda |
US | United States of America |
UY | Uruguay |
UZ | Uzbekistan |
VA | Holy See (Vatican City State) |
VC | Saint Vincent and the Grenadines |
VE | Venezuela |
VG | British Virgin Islands (Tortola) |
VI | United States Virgin Islands |
VN | Vietnam |
VU | Vanuatu |
WF | Wallis and Futuna |
WS | Western Samoa |
YE | Yemen (Rep. of) |
YT | Mayotte |
ZA | South Africa |
ZM | Zambia |
ZW | Zimbabwe |
ZZ | Equatorial Kundu |
Last modification: Sep. 6th 2024