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.
Request
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
Responses
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
Secured by
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. ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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" }
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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
Request
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" } }
Responses
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
Secured by
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.
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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 }
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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.Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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 ]
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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 ]
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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.
Request
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
Responses
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
Secured by
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 ¶
Request
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
Responses
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
Secured by
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