Domain API

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

Gandi Domain Management API

Introduction

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

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

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

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

Domain Change Owner

https://api.sandbox.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
    • domainstring
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Required
    • ownerobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody", "reseller"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not "individual".
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    Optional
    • adminobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody", "reseller"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not "individual".
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • billobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody", "reseller"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not "individual".
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • techobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody", "reseller"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not "individual".
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    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"
      }
    }

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
Headers
  • Optional
    • Warningstring
      Warning message
Body
  • application/json
    object

    With the following properties:

    • statusstring

      One of: "success", "error"

      Response status.
    Optional
    • errorsarray
      A list of all the errors encountered during validation.

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

          One of: "header", "path", "querystring", "body"

          The field's location in the HTTP response.
        • namestring
          The xpath of the field.

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

get Change Owner followup.

This route is used to check a change owner status.

Request

URI Parameters
    • domainstring
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • created_atdatetime
    • paramsobject

      With the following properties:

      Optional
      • answer_new_ownerstring
      • answer_old_ownerstring
      • inner_stepstring
      • new_owner_emailstring
      • old_admin_emailstring
      • old_owner_emailstring
    • stepstring
    • step_nbinteger
    • updated_atdatetime
    Optional
    • date_startstring
    • errortypestring
    • errortype_labelstring
    • foaarray

      Of items of type:

      • object

        With the following properties:

        • answerstring
        • emailstring
    • inner_stepstring
    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

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Resend the change owner FOA emails

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

post Resend the change owner FOA emails

This route is used to resend the Form of Authorization to the current domain owner.

Request

URI Parameters
    • domainstring
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • emailstring
    Example:
    {
      "email": "alice@example.org"
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Availability

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

get Domain availability

Request

Query String
  • Required
    • namestring
      domain name to query
    Optional
    • countrystring
      ISO country code for which taxes are to be applied
    • currencystring
      request price for a specific ISO currency code
    • duration_unitstring
      define the unit for max_duration
    • extensionstring
      query a specific extension for product options
    • gridstring
      request price for a specific rate
    • langstring
      language code
    • max_durationinteger
      set a limit on the duration range for returned prices
    • periodstring
      specific registration period to query
    • processesarray[ string ]

      Default: ["create"]

      list of at least 1 process for which pricing is to be made
    • sharing_idstring
      Organization for which the pricing is to be made. See the reference.
Example - Availability and price for registration:
?name=example.com
Example - Availability and price, with processes and price rate:
?name=example.com&processes=create&processes=transfer&grid=C
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • currencystring
    • gridstring
    • productsarray

      Of items of type:

      • object

        With the following properties:

        • namestring
          product name
        • pricesarray

          Of items of type:

          • object

            With the following properties:

            • duration_unitstring
              time unit for duration
            • max_durationinteger
              maximum duration for which this price unit applies
            • min_durationinteger
              minimum duration for which this price unit applies
            • price_after_taxesnumber
              pricing after tax is applied
            • price_before_taxesnumber
              pricing before tax is applied
            Optional
            • discountboolean
              indicate if a discount is active on this price unit
            • normal_price_after_taxesnumber
              pricing after tax is applied, when no discount applies
            • normal_price_before_taxesnumber
              pricing before tax is applied, when no discount applies
            • optionsobject

              With the following properties:

              Optional
              • periodstring
                registration period
            • typestring
              pricing type involved
        • statusstring

          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 available
          • available_reserved: Domain name reserved under special conditions
          • available_preorder: Domain name can be pre-ordered
          • unavailable: Domain name is not available
          • unavailable_premium: Domain name is not available
          • unavailable_restricted: Domain name is not available (forbidden)
          • error_invalid: Provided value is not a valid domain name
          • error_refused: Service is temporarily down
          • error_timeout: Service timed out, try the method again later
          • error_unknown: Internal server error
          • reserved_corporate: The TLD for the given domain name is reserved for Gandi Corporate Services customers
          • pending: Result is not yet ready, try the method again later
          • error_eoi: The TLD for the given domain name is in an Expression of Interest (EOI) period
        • taxesarray

          Of items of type:

          • object

            With the following properties:

            • namestring
              name of the tax
            • ratenumber
              rate in percent
            • typestring
              type of tax
        Optional
        • periodsarray

          Of items of type:

          • object

            With the following properties:

            • namestring
              name of the registration period
            • starts_atdatetime
              start of the registration period
            Optional
            • ends_atdatetime
              end of the registration period if it's not General Availability (golive)
        • processstring
          process for this price
    • taxesarray

      Of items of type:

      • object

        With the following properties:

        • namestring
          name of the tax
        • ratenumber
          rate in percent
        • typestring
          type of tax
    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

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Create and List

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

get List domains

This route returns a list of domains owned by your user.

Request

Query String
  • Optional
    • fqdnstring
      Filters the list by domain name, with optional patterns.
      Example: example.net
      Example: example.*
      Example: *example.com
    • nameserverstring

      One of: "abc", "livedns", "other"

      Used to filter the type of nameservers
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
    • resellee_idstring
      Filter the list by resellee_id, from the Organization API
      Example: 5a53edc7-b514-416a-98c2-2d477a288eb9
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
    • sort_bystring

      Default: "fqdn"

      Used to specify how you want the results sorted.
    • tldstring
      Used to filter by just the extension.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
    • Acceptstring
      When passed text/csv value, this route will return a CSV-formatted response.

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Filtered-Countinteger
      On a filtered list, this is the number of matching items.
    • Linkstring
      Links to next and last page.
Body
  • application/json
    array

    Of items of type:

    • object

      With the following properties:

      • autorenewboolean
        Automatic renewal status. Learn more about automatic renewal.
      • datesobject
        Domain's life cycle dates.

        With the following properties:

        • registry_created_atdatetime
        • updated_atdatetime
        Optional
        • authinfo_expires_atdatetime
        • created_atdatetime
        • deletes_atdatetime
        • hold_begins_atdatetime
        • hold_ends_atdatetime
        • pending_delete_ends_atdatetime
        • registry_ends_atdatetime
        • renew_begins_atdatetime
        • restore_ends_atdatetime
      • domain_ownerstring
      • fqdnstring
        Fully qualified domain name, written in its native alphabet (IDN).
      • fqdn_unicodestring
        Fully qualified domain name, written in unicode (learn more).
      • hrefstring
        Link to domain details.
      • idstring
        UUID
      • nameserverobject

        With the following properties:

        • currentstring
        Optional
        • hostsarray[ string ]
      • orga_ownerstring
      • ownerstring
      • statusarray

        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.
      • tldstring
      Optional
      • sharing_idstring
        UUID
      • tagsarray[ string ]
        List of tags that have been assigned to the domain name.
    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"
      }
    ]
  • text/csv
    any
    CSV-formatted response.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

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_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Required
    • fqdnstring
    • ownerobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    Optional
    • adminobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • billobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • claimsstring
      The value of the notice_id returned by the claims route. Warning Make sure your customer did read the notice information about the trademark owner
    • currencystring

      One of: "EUR", "USD", "GBP", "TWD", "CNY"

    • durationinteger

      Minimum: 1

      Maximum: 10

    • enforce_premiumboolean
      Must be set to true if the domain is a premium domain.
    • extra_parametersobject
      Extra parameters needed for some extensions. See this list for possible values.
    • langstring
      ISO-639-2 language code of the domain, required for some IDN domains.
    • nameserversarray[ string ]
      List of nameservers. Gandi's LiveDNS nameservers are used if omitted.
    • nameservers_ipsobject
      For 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"
        ]
      }
    • pricenumber
    • resellee_idstring
    • smdstring
      Contents of a Signed Mark Data file (used for newgtld sunrises, tld_period must be sunrise)
    • techobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • template_idstring
      Template applied when the process is done. It must be a template ID as you can retrieve it using the Template API.
    • tld_periodstring

      One of: "sunrise", "landrush", "eap1", "eap2", "eap3", "eap4", "eap5", "eap6", "eap7", "eap8", "eap9", "golive"

    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 response. You will get this response when you send your request. with a Dry-Run: 1 header.
Headers
  • Optional
    • Warningstring
      Warning message
Body
  • application/json
    object

    With the following properties:

    • statusstring

      One of: "success", "error"

      Response status.
    Optional
    • errorsarray
      A list of all the errors encountered during validation.

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

          One of: "header", "path", "querystring", "body"

          The field's location in the HTTP response.
        • namestring
          The xpath of the field.

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Information

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

delete Domain delete

This route is used to delete domain name.
Warning: the domain deletion is currently a restricted feature.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

get Domain details

This route is used to find and return information about a domain to which you have permissions.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • autorenewobject

      With the following properties:

      • hrefstring
      Optional
      • datesarray[ datetime ]
      • durationinteger

        Default: 1

      • enabledboolean

        Default: false

      • org_idstring
        UUID
    • can_tld_lockboolean
    • contactsobject

      With the following properties:

      • adminobject

        With the following properties:

        • countrystring
          A country code. See the country code list for possible values.
        • emailstring
        • familystring
          Contact's family name (usualy the lastname)
        • givenstring
          Contact's given name (usualy the firstname)
        • same_as_ownerboolean
          Will be true when the contact used is the same as the owner.
        • streetaddrstring
        • typestring

          One of: "individual", "company", "association", "publicbody"

        Optional
        • brand_numberstring
        • citystring
        • data_obfuscatedboolean
        • extra_parametersobject
          Extra parameters needed for some extensions. See this list for possible values.
        • faxstring
        • jo_announce_numberstring
        • jo_announce_pagestring
        • jo_declaration_datestring
        • jo_publication_datestring
        • mail_obfuscatedboolean
        • mobilestring
        • orgnamestring
          The legal name of the company, association, or public body if the contact type is not 0.
        • phonestring
        • reachabilitystring

          One of: "pending", "done", "failed", "deleted", "none"

          Learn more about reachability here.
        • sharing_idstring
        • sirenstring
        • statestring
          Learn more about state codes here
        • validationstring

          One of: "pending", "done", "failed", "deleted", "none"

        • zipstring
      • billobject

        With the following properties:

        • countrystring
          A country code. See the country code list for possible values.
        • emailstring
        • familystring
          Contact's family name (usualy the lastname)
        • givenstring
          Contact's given name (usualy the firstname)
        • same_as_ownerboolean
          Will be true when the contact used is the same as the owner.
        • streetaddrstring
        • typestring

          One of: "individual", "company", "association", "publicbody"

        Optional
        • brand_numberstring
        • citystring
        • data_obfuscatedboolean
        • extra_parametersobject
          Extra parameters needed for some extensions. See this list for possible values.
        • faxstring
        • jo_announce_numberstring
        • jo_announce_pagestring
        • jo_declaration_datestring
        • jo_publication_datestring
        • mail_obfuscatedboolean
        • mobilestring
        • orgnamestring
          The legal name of the company, association, or public body if the contact type is not 0.
        • phonestring
        • reachabilitystring

          One of: "pending", "done", "failed", "deleted", "none"

          Learn more about reachability here.
        • sharing_idstring
        • sirenstring
        • statestring
          Learn more about state codes here
        • validationstring

          One of: "pending", "done", "failed", "deleted", "none"

        • zipstring
      • ownerobject

        With the following properties:

        • countrystring
          A country code. See the country code list for possible values.
        • emailstring
        • familystring
          Contact's family name (usualy the lastname)
        • givenstring
          Contact's given name (usualy the firstname)
        • streetaddrstring
        • typestring

          One of: "individual", "company", "association", "publicbody"

        Optional
        • brand_numberstring
        • citystring
        • data_obfuscatedboolean
        • extra_parametersobject
          Extra parameters needed for some extensions. See this list for possible values.
        • faxstring
        • jo_announce_numberstring
        • jo_announce_pagestring
        • jo_declaration_datestring
        • jo_publication_datestring
        • mail_obfuscatedboolean
        • mobilestring
        • orgnamestring
          The legal name of the company, association, or public body if the contact type is not 0.
        • phonestring
        • reachabilitystring

          One of: "pending", "done", "failed", "deleted", "none"

          Learn more about reachability here.
        • sharing_idstring
        • sirenstring
        • statestring
          Learn more about state codes here
        • validationstring

          One of: "pending", "done", "failed", "deleted", "none"

        • zipstring
      • techobject

        With the following properties:

        • countrystring
          A country code. See the country code list for possible values.
        • emailstring
        • familystring
          Contact's family name (usualy the lastname)
        • givenstring
          Contact's given name (usualy the firstname)
        • same_as_ownerboolean
          Will be true when the contact used is the same as the owner.
        • streetaddrstring
        • typestring

          One of: "individual", "company", "association", "publicbody"

        Optional
        • brand_numberstring
        • citystring
        • data_obfuscatedboolean
        • extra_parametersobject
          Extra parameters needed for some extensions. See this list for possible values.
        • faxstring
        • jo_announce_numberstring
        • jo_announce_pagestring
        • jo_declaration_datestring
        • jo_publication_datestring
        • mail_obfuscatedboolean
        • mobilestring
        • orgnamestring
          The legal name of the company, association, or public body if the contact type is not 0.
        • phonestring
        • reachabilitystring

          One of: "pending", "done", "failed", "deleted", "none"

          Learn more about reachability here.
        • sharing_idstring
        • sirenstring
        • statestring
          Learn more about state codes here
        • validationstring

          One of: "pending", "done", "failed", "deleted", "none"

        • zipstring
    • datesobject
      Domain's life cycle dates.

      With the following properties:

      • registry_created_atdatetime
      • updated_atdatetime
      Optional
      • authinfo_expires_atdatetime
      • created_atdatetime
      • deletes_atdatetime
      • hold_begins_atdatetime
      • hold_ends_atdatetime
      • pending_delete_ends_atdatetime
      • registry_ends_atdatetime
      • renew_begins_atdatetime
      • restore_ends_atdatetime
    • fqdnstring
      Fully qualified domain name, written in its native alphabet (IDN).
    • fqdn_unicodestring
      Fully qualified domain name, written in unicode (learn more).
    • hrefstring
      Link to domain details.
    • nameserversarray[ string ]

      Minimum items: 1

    • reachabilitystring

      One of: "pending", "done", "failed", "deleted", "none"

    • servicesarray
      List 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"

    • sharing_spaceobject

      With the following properties:

      • idstring
        UUID
      • namestring
      • typestring
      Optional
      • resellerboolean
      • sharing_spaceobject

        With the following properties:

        • idstring
          UUID
        • namestring
    • statusarray

      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.
    • tldstring
    Optional
    • authinfostring
    • idstring
      Domain ID
    • sharing_idstring
      UUID
    • tagsarray[ string ]
      List of tags that have been assigned to the domain name.
    • trustee_rolesarray

      Of items of type:

      • object

        With the following properties:

        • allow_transferoutboolean
        • editableboolean
        • namestring

          One of: "owner", "admin", "tech", "bill"

    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"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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 code management

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

put Reset of authorization code

Will start an asynchrounous reset of the registry authorization code, if possible (some registries don't handle this and will return a 400 error)

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Automatic Renewal

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

patch Edit autorenew status

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • enabledboolean
    Optional
    • durationinteger

      Default: 1

      Minimum: 1

      Maximum: 9

    • org_idstring
    Example:
    {
      "duration": 1,
      "enabled": true
    }

Responses

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain claims information

https://api.sandbox.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
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • claimsarray

      Of items of type:

      • object

        With the following properties:

        • contactsarray
          managers (agents) of the trademark on behalf of the owners

          Of items of type:

          • object
            Contact information related to a contact / holder

            With the following properties:

            Optional
            • ccstring
            • citystring
            • emailstring
            • faxstring
            • namestring
            • orgstring
            • pcstring
            • phonestring
            • spstring
            • streetstring
        • goods_and_servicesstring
          A very long string describing the trademark categories
        • holdersarray
          Owner(s) of the trademark

          Of items of type:

          • object
            Contact information related to a contact / holder

            With the following properties:

            Optional
            • ccstring
            • citystring
            • emailstring
            • faxstring
            • namestring
            • orgstring
            • pcstring
            • phonestring
            • spstring
            • streetstring
        • jurisdiction_classesarray

          Of items of type:

          • integer
            List of Nice WIPO class numbers (reference)
        • jurisdiction_countrystring
        Optional
        • mark_namestring
    • created_atstring
    • expires_atstring
      Warning each notice is valid for an approximate 48 hours, you will get another value after a few hours
    • fqdnstring
    • fqdn_alabelstring
    • fqdn_ulabelstring
    • notice_idstring
      Notice identifier. This should be sent as the "claims" property to the POST on /domains
    • statusstring

      One of: "new", "accepted"

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

404

Body
  • application/josn
    any
    Expected response when no claim is accociated with this domain

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

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
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Contacts

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

get Domain contact list

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • adminobject

      With the following properties:

      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • same_as_ownerboolean
        Will be true when the contact used is the same as the owner.
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • reachabilitystring

        One of: "pending", "done", "failed", "deleted", "none"

        Learn more about reachability here.
      • sharing_idstring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • billobject

      With the following properties:

      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • same_as_ownerboolean
        Will be true when the contact used is the same as the owner.
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • reachabilitystring

        One of: "pending", "done", "failed", "deleted", "none"

        Learn more about reachability here.
      • sharing_idstring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • ownerobject

      With the following properties:

      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • reachabilitystring

        One of: "pending", "done", "failed", "deleted", "none"

        Learn more about reachability here.
      • sharing_idstring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • techobject

      With the following properties:

      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • same_as_ownerboolean
        Will be true when the contact used is the same as the owner.
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • reachabilitystring

        One of: "pending", "done", "failed", "deleted", "none"

        Learn more about reachability here.
      • sharing_idstring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    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"
      }
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

patch Domain contact update

This route let you update a domain contact(s). Please note that you can only change the admin, tech and billing contact information using this route. Should you need to update the domain's owner information, please use the owner route.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Optional
    • adminobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • billobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • ownerobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • streetaddrstring
      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • familystring
        Contact's family name (usualy the lastname)
      • faxstring
      • givenstring
        Contact's given name (usualy the firstname)
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • techobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • icann_contract_acceptboolean

        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_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    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"
      }
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Owner

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

put Edit domain owner

This route let you change some of the domain's owner information. At the moment you can't change information that could trigger a full change of ownership (such as the names).

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Required
    • countrystring
      A country code. See the country code list for possible values.
    • emailstring
    • streetaddrstring
    Optional
    • brand_numberstring
    • citystring
    • data_obfuscatedboolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parametersobject
      Extra parameters needed for some extensions. See this list for possible values.
    • familystring
      Contact's family name (usualy the lastname)
    • faxstring
    • givenstring
      Contact's given name (usualy the firstname)
    • icann_contract_acceptboolean

      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_numberstring
    • jo_announce_pagestring
    • jo_declaration_datestring
    • jo_publication_datestring
    • langstring

      One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

    • mail_obfuscatedboolean
    • mobilestring
    • phonestring
    • sirenstring
    • statestring
      Learn more about state codes here
    • validationstring

      One of: "pending", "done", "failed", "deleted", "none"

    • zipstring

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
Headers
  • Optional
    • Warningstring
      Warning message
Body
  • application/json
    object

    With the following properties:

    • statusstring

      One of: "success", "error"

      Response status.
    Optional
    • errorsarray
      A list of all the errors encountered during validation.

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

          One of: "header", "path", "querystring", "body"

          The field's location in the HTTP response.
        • namestring
          The xpath of the field.

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Creation Status

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

get Domain Creation Status

This route returns the domain creation status. Once a domain has been succesfuly registered, a redirection to the Domain Information route will be sent as a response.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • stepstring

      One of: "BILL", "WAIT", "RUN", "SUPPORT", "ERROR"

    • step_nbinteger
    Optional
    • errortypestring
    • errortype_labelstring

303

Headers
    • Locationstring

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

DNSSEC Keys Management

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

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

get DNS Key List

This route returns the list of all the DNS Keys installed on a domain.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Linkstring
      Links to next and last page.
Body
  • application/json
    array

    Of items of type:

    • object

      With the following properties:

      • algorithminteger

        Minimum: 0

        Maximum: 255

        Algorithm
      • digeststring
        Key Digest
      • digest_typeinteger

        Minimum: 0

        Maximum: 255

        Key Digest Type
      • hrefstring
        URL to this DNS Key
      • idinteger
        Id
      • keytaginteger
        Key Tag
      • typestring

        One of: "none", "zsk", "ksk"

        Key Type
      Optional
      • public_keystring
        Public Key

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

post Create a new DNS Key

This route lets you add a new DNS Key on a domain.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • algorithminteger

      Minimum: 0

      Maximum: 255

      Algorithm
    • public_keystring
      Public Key
    • typestring

      One of: "none", "zsk", "ksk"

      Key Type
    Example:
    {
      "algorithm": 13,
      "type": "zsk",
      "public_key": "ZhCa3rGLofZcndFN2aVd=="
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

put Replace keys on this domain

This route lets you replace all the DNS Keys on a domain.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • keysarray

      Of items of type:

      • object

        With the following properties:

        Required
        • algorithminteger

          Minimum: 0

          Maximum: 255

          Algorithm
        • public_keystring
          Public Key
        • typestring

          One of: "none", "zsk", "ksk"

          Key Type
    Example:
    {
      "keys": [
        {
          "algorithm": 13,
          "type": "zsk",
          "public_key": "ZhCa3rGLofZcndFN2aVd=="
        },
        {
          "algorithm": 13,
          "type": "ksk",
          "public_key": "SWF0mbNsQJGzhjbB2jiqTcN9JM3Igg=="
        }
      ]
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

DNSSEC Key deletion

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

delete Delete a DNSSEC Key

This route lets you remove a DNS Key on a domain. You can get the key id in the key list result.

Request

URI Parameters
    • domainstring
      Domain name.
    • idstring
      Key ID
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Glue Record Management

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

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

Learn more.

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

get Glue record list

This route returns the list of glue records for the given domain, with their associated IP addresses.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Linkstring
      Links to next and last page.
Body
  • application/json
    array

    Of items of type:

    • object

      With the following properties:

      • fqdnstring
        Fully qualified domain name, written in its native alphabet (IDN).
      • fqdn_unicodestring
        Fully qualified domain name, written in unicode.
      • hrefstring
        URL to this host's details.
      • ipsarray[ string ]
        List of this host's registered IP addresses.
      • namestring
        Name 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"
      },
      {
        "ips": [
          "203.0.113.2"
        ],
        "name": "@",
        "fqdn": "example.net",
        "href": "http://api.test/v5/domain/domains/example.net/hosts/@",
        "fqdn_unicode": "example.net"
      }
    ]

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

post Create a new glue record

This route is used to create a new glue record.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • ipsarray[ string ]
      List of IP addresses.
    • namestring
      Host 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"
      ]
    }

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Linkstring
      Links to next and last page.

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Glue record information

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

get Glue record information

This route returns information on a specific glue record for the given domain.

Request

URI Parameters
    • domainstring
      Domain name.
    • namestring
      Host name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • fqdnstring
      Fully qualified domain name, written in its native alphabet (IDN).
    • fqdn_unicodestring
      Fully qualified domain name, written in unicode.
    • hrefstring
      URL to this host's details.
    • ipsarray[ string ]
      List of this host's registered IP addresses.
    • namestring
      Name 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"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

put Update a glue record

This route is used to update an existing glue record.

Request

URI Parameters
    • domainstring
      Domain name.
    • namestring
      Host name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • ipsarray[ string ]
      List of IP addresses.
    Example:
    {
      "ips": [
        "203.0.113.2",
        "203.0.113.3",
        "2001:db8:0:0:0:0:0:00ff"
      ]
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

delete Delete a glue record

Request

URI Parameters
    • domainstring
      Domain name.
    • namestring
      Host name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

LiveDNS Management

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

get Domain LiveDNS Information

This route returns LiveDNS status information for the given domain.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • currentstring

      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, and other is for custom nameservers.
    • nameserversarray[ string ]
      List of current nameservers.
    Optional
    • dnssec_availableboolean
      Indicates if DNSSEC may be applied to the domain.
    • livednssec_availableboolean
      Indicates 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"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

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
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Nameservers Management

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

get Domain Nameserver Information

This route returns the nameservers that are currently set on this domain.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

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

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

put Update Domain Nameserver List

This route is used to change the nameservers that are set on a given domain.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • nameserversarray[ string ]
      List of FQDNs.
    Example:
    {
      "nameservers": [
        "ns1.example.net",
        "ns2.example.net"
      ]
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Resend reachability email

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

patch Resend reachability email

This route is meant to resend the email that is used to validate that the owner of a domain is reachable Learn more about reachability here

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • actionstring

      One of: "resend"

    Example:
    {
      "action": "resend"
    }

Responses

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Renewal

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

get Domain renewal information

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • begins_atstring
    • durationsarray[ integer ]
    • maximuminteger
    • minimuminteger
    • prohibitedboolean
    Optional
    • ends_atstring
    • in_renew_periodboolean
    Example:
    {
      "in_renew_period": true,
      "durations": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8
      ],
      "maximum": 8,
      "minimum": 1,
      "prohibited": false,
      "begins_at": "2012-01-01T00:00:00Z",
      "ends_at": "2021-03-30T00:00:00Z"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

post Renew a Domain

This route is used to renew domain names. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Optional
    • durationinteger

      Default: 1

      Minimum: 1

      Maximum: 9

      The duration (in years) of the renewal.
    Example:
    {
      "duration": 2
    }

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
Headers
  • Optional
    • Warningstring
      Warning message
Body
  • application/json
    object

    With the following properties:

    • statusstring

      One of: "success", "error"

      Response status.
    Optional
    • errorsarray
      A list of all the errors encountered during validation.

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

          One of: "header", "path", "querystring", "body"

          The field's location in the HTTP response.
        • namestring
          The xpath of the field.

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain Restore

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

get Domain restore information

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • restorableboolean
    Optional
    • contractsarray

      Of items of type:

      • object

        With the following properties:

        • idstring
        • namestring
        Optional
        • hrefstring
        • registry_contract_hrefstring
    Example:
    {
      "restorable": true
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

post Restore a Domain

This route is used to restore domain names (learn more about restoration). Warning! This is not a free operation. Please ensure your prepaid account has enough credit.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Transfer lock status

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

patch Transfer lock/unlock

Most extensions have a transfer protection mechanism, that consists of a lock that can be put on the domain. When the transfer lock is enabled, the domain can't be transferred. To unlock : clientTransferProhibited=false. To lock : clientTransferProhibited=true.

Warning: Transferring a domain name consists of entrusting its management to another domain name provider. During this process, an authorization code may be required. By transferring a domain away from Gandi, you will lose products that came with the domain. For example, any GandiMail mailboxes associated with the domain name will no longer work, and all emails will be deleted. When a domain is part of a Website Pack subscription, transferring this domain out will remove the domain from the subscription. Completing this action during the two months following domain creation will result in your Website Pack being split and the domain being made unavailable for a certain period, depending on the rules of the registry. The hosting subscription will continue as a monthly payment, though you can cancel the hosting subscription at any time.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • clientTransferProhibitedboolean
    Example:
    {
      "clientTransferProhibited": true
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Manage domain tags

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

get Get the list of tags linked to a domain

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    array[ string ]
    Example:
    [
      "to renew",
      "tag 2"
    ]

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

post Attach a new tag to the domain

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • tagstring
    Example:
    {
      "tag": "to renew"
    }

Responses

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

put Update all the tags of the domain

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • tagsarray[ string ]
    Example:
    {
      "tags": [
        "to renew",
        "tag 2"
      ]
    }

Responses

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

patch Update some of the tags of the domain

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • addarray[ string ]
    • removearray[ string ]
    Example:
    {
      "add": [
        "premium",
        "need website"
      ],
      "remove": [
        "to renew"
      ]
    }

Responses

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

delete Remove all tags from this domain

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • messagestring

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain transfer to another registrar

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

post Accept or decline a transfer to another registrar

The following route is used to validate transfer of a domain to another registrar than Gandi. You may read the transfer out documentation

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • acceptboolean
    • authinfostring
    Example:
    {
      "authinfo": "xyz5500",
      "accept": true
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Web redirections

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

get List web redirections

This route is used to list all the web redirections available on a domain.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
    • Acceptstring
      When passed text/csv value, this route will return a CSV-formatted response.

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Linkstring
      Links to next and last page.
Body
  • application/json
    array

    Of items of type:

    • object

      With the following properties:

      • hoststring
        Source hostname (including the domain name)
      • typestring

        One of: "cloak", "http301", "http302"

        Type of redirection
      • urlstring
        Target URL
      Optional
      • cert_statusstring
      • cert_uuidstring
      • created_atstring
      • protocolstring

        One of: "http", "https", "httpsonly"

      • updated_atstring
  • text/csv
    any
    CSV-formatted response.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

post Create a new web redirection

This route is used to create a new web redirection.

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • hoststring
      Source hostname (including the domain name)
    • overrideboolean
      When you create a redirection on a domain a DNS record is created if it does not exist. When the record already exists and this parameter is set to true it will overwrite the record. Otherwise it will trigger an error.
    • protocolstring

      One of: "http", "https", "httpsonly"

    • typestring

      One of: "cloak", "http301", "http302"

      Type of redirection
    • urlstring
      Target URL
    Example:
    {
      "host": "www.example.net",
      "override": true,
      "protocol": "https",
      "type": "http301",
      "url": "http://www.example.org/"
    }

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Linkstring
      Links to next and last page.

201

The resource has been created.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Web redirection information

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

get Get web redirection information

This route is used to retrieve information about a given redirection.

Request

URI Parameters
    • domainstring
      Domain name.
    • hoststring
      Host name
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • hoststring
      Source hostname (including the domain name)
    • typestring

      One of: "cloak", "http301", "http302"

      Type of redirection
    • urlstring
      Target URL
    Optional
    • cert_statusstring
    • cert_uuidstring
    • created_atstring
    • protocolstring

      One of: "http", "https", "httpsonly"

    • updated_atstring

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

patch Update a redirection

This route is used to update a given redirection.

Request

URI Parameters
    • domainstring
      Domain name.
    • hoststring
      Host name
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Optional
    • overrideboolean
      If true, a DNS record will be created. When the value is false and no matching DNS record exists, it will trigger an error.
    • protocolstring

      One of: "http", "https", "httpsonly"

    • typestring

      One of: "cloak", "http301", "http302"

      Type of redirection
    • urlstring
      Target URL
    Example:
    {
      "override": true,
      "protocol": "http",
      "type": "http302"
    }

Responses

200

Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

delete Delete a redirection

This route is used to remove a given redirection.

Request

URI Parameters
    • domainstring
      Domain name.
    • hoststring
      Host name
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • messagestring

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

List Available TLD Extensions

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

get List available TLD extensions

Request

Query String
  • Optional
    • categorystring

      One of: "ccTLD", "gTLD"

      Category of the TLD
    • pageinteger

      Default: 1

      Minimum: 1

      Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
    • per_pageinteger

      Minimum: 1

      How many items to display per page.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Headers
    • Total-Countinteger
      Total number of items.
    Optional
    • Linkstring
      Links to next and last page.
Body
  • application/json
    array

    Of items of type:

    • object

      With the following properties:

      • hrefstring
        Link to TLD details.
      • namestring
        Name of the TLD.
    Example:
    [
      {
        "name": "com",
        "href": "https://api.test/v5/domain/tlds/com"
      },
      {
        "name": "eu",
        "href": "https://api.test/v5/domain/tlds/eu"
      },
      {
        "name": "fr",
        "href": "https://api.test/v5/domain/tlds/fr"
      },
      {
        "name": "info",
        "href": "https://api.test/v5/domain/tlds/info"
      },
      {
        "name": "net",
        "href": "https://api.test/v5/domain/tlds/net"
      },
      {
        "name": "org",
        "href": "https://api.test/v5/domain/tlds/org"
      }
    ]

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

TLD Information

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

get TLD Details

This route is used to find and return information about any TLD extension that Gandi manages.

Request

URI Parameters
    • namestring
      Name of the TLD, or a FQDN.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • authinfo_for_transferboolean
      true if authinfo is required prior to transfer.
    • categorystring

      One of: "ccTLD", "gTLD"

      Category of the TLD.
    • change_ownerboolean
      true if change owner is allowed.
    • corporateboolean
      true if this is a corporate TLD.
    • ext_tradeboolean
    • full_tldstring
    • hrefstring
      Link to TLD details.
    • lockboolean
    • namestring
      Name of the TLD.
    Example:
    {
      "category": "ccTLD",
      "name": "eu",
      "lock": false,
      "change_owner": true,
      "authinfo_for_transfer": true,
      "full_tld": "eu",
      "corporate": false,
      "ext_trade": true,
      "href": "https://api.test/v5/domain/tlds/eu"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain transfer operations

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

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

post Transfer a domain to Gandi

This route is used to start transferring a domain to Gandi. Warning! This is not a free operation. Please ensure your prepaid account has enough credit.

Pay as an individual

To pay with your user organization (ie: yourself as an individual), just use the regular required parameters. The invoice will be edited with your personal information.

For this to work, you need to:

  • use the same first name and last name for the domain name's owner

Pay as another organization

To pay using another organization, you'll need to perform the request with the organization's ID as the sharing_id query string parameter (see reference). The invoice will be edited using this organization's information.

For this to work, you need to:

  • have billing permissions on the organization
  • use the same organization name for the domain name's owner

Special case - transfer a domain as a reseller organization

Should you want to transfer a domain for a customer using a reseller account, you'll need the ID (see reference) of your reseller account and your customer's information for the owner. Then, you'll perform the request with sharing_id=<reseller-id> in the query string and the owner information in the payload. The invoice will be edited with the reseller organization's information.

For this to work, you need to:

  • have billing permissions on the reseller organization

Request

Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Required
    • fqdnstring
    • ownerobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    Optional
    • adminobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • authinfostring
    • billobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • change_ownerboolean
    • currencystring

      One of: "EUR", "USD", "GBP", "TWD", "CNY"

    • durationinteger

      Minimum: 1

      Maximum: 10

    • enforce_premiumboolean
      Must be set to true if the domain is a premium domain.
    • extra_parametersobject
      Extra parameters needed for some extensions. See this list for possible values.
    • nameserversarray[ string ]
      List of nameservers. Gandi's LiveDNS nameservers are used if omitted.
    • nameservers_ipsobject
      For 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"
        ]
      }
    • pricenumber
    • resellee_idstring
    • techobject

      With the following properties:

      Required
      • countrystring
        A country code. See the country code list for possible values.
      • emailstring
      • familystring
        Contact's family name (usualy the lastname)
      • givenstring
        Contact's given name (usualy the firstname)
      • streetaddrstring
      • typestring

        One of: "individual", "company", "association", "publicbody"

      Optional
      • brand_numberstring
      • citystring
      • data_obfuscatedboolean

        Default: true

        Learn more about WHOIS privacy at Gandi here.
      • extra_parametersobject
        Extra parameters needed for some extensions. See this list for possible values.
      • faxstring
      • jo_announce_numberstring
      • jo_announce_pagestring
      • jo_declaration_datestring
      • jo_publication_datestring
      • langstring

        One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

      • mail_obfuscatedboolean
      • mobilestring
      • orgnamestring
        The legal name of the company, association, or public body if the contact type is not 0.
      • phonestring
      • sirenstring
      • statestring
        Learn more about state codes here
      • validationstring

        One of: "pending", "done", "failed", "deleted", "none"

      • zipstring
    • template_idstring
      Template applied when the process is done. It must be a template ID as you can retrieve it using the Template API.
    Example:
    {
      "fqdn": "example.com",
      "authinfo": "xyz5500",
      "duration": 2,
      "owner": {
        "city": "Paris",
        "given": "Alice",
        "family": "Doe",
        "zip": "75001",
        "country": "FR",
        "streetaddr": "5 rue neuve",
        "phone": "+33.123456789",
        "state": "FR-IDF",
        "type": "individual",
        "email": "alice@example.org"
      }
    }

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
Headers
  • Optional
    • Warningstring
      Warning message
Body
  • application/json
    object

    With the following properties:

    • statusstring

      One of: "success", "error"

      Response status.
    Optional
    • errorsarray
      A list of all the errors encountered during validation.

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

          One of: "header", "path", "querystring", "body"

          The field's location in the HTTP response.
        • namestring
          The xpath of the field.

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Domain transfer followup

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

get Get transfer status

This route is used to check a domain transfer status. When the transfer process is finalized, the step value is done.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • created_atstring
    • owner_contactstring
    • paramsobject

      With the following properties:

      • domainstring
      Optional
      • durationinteger
      • resellerstring
      • tldstring
      • versioninteger
    • stepstring
    • step_nbinteger
    • updated_atstring
    Optional
    • errortypestring
    • errortype_labelstring
    • foaarray

      Of items of type:

      • object

        With the following properties:

        • answerstring
        • emailstring
    • inner_stepstring
    • regac_atstring
    • start_atstring
    • transfer_linkstring
    • transfer_procedurestring

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

put Relaunch transfer process

This route is used to relaunch the transfer process in case something went wrong.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

404

A 404 response is sent when the domain is in an error state.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Update authinfo

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

put Update authinfo code of a pending transfer

This route is used to update the authinfo code of a pending transfer, in case it was not specified or was invalid.

Note that the sharing_id is needed when trying to change the code for a given organization

Request

URI Parameters
    • domainstring
      Domain name.
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • authinfostring
    Example:
    {
      "authinfo": ".example!authinfo02"
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Check transfer availability

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

post Check transfer availability

This route is used to check whether a domain can be transferred to Gandi. You can provide an authorization code if required

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Optional
    • authinfostring
    Example:
    {
      "authinfo": "xyz5500"
    }

Responses

200

Body
  • application/json
    object

    With the following properties:

    • availableboolean
    • fqdnstring
    • fqdn_alabelstring
    • fqdn_ulabelstring
    Optional
    • corporateboolean
    • durationsarray[ integer ]
    • internalboolean
    • maximum_durationinteger
    • minimum_durationinteger
    • msgstring

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Resend the transfer FOA emails

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

post Resend the transfer FOA emails

This route is used to resend the Form of Authorization to the current domain owner.

Request

URI Parameters
    • domainstring
      Domain name.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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
Body
  • application/json
    object

    With the following properties:

    Required
    • emailstring
    Example:
    {
      "email": "alice@example.net"
    }

Responses

202

The request has been accepted.
Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

403

In case the bearer token has expired, does not have enought permission or does not exists.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Bearer for access token, or Apikey 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

Appendix

Domain Extra Parameters

This parameters need to be sent during domain creation and transfer, depending on the extension of the domain being created or transfered.
  • object

    With the following properties:

    Optional
    • x-aero_ens_authidstring
      aero id (you can apply for an .aero id on http://www.information.aero/)
    • x-aero_ens_authkeystring
      aero password
    • x-au_registrant_id_numberstring
    • x-au_registrant_id_typestring
      owner's document type
    • x-az_admin_pp_idstring
      ID number for a Physical Person admin contact
    • x-az_billing_pp_idstring
      ID number for a Physical Person billing contact
    • x-az_registrant_company_numberstring
      Company number for a Moral Person registrant contact
    • x-az_registrant_pp_idstring
      ID number for a Physical Person registrant contact
    • x-az_tech_pp_idstring
      ID number for a Physical Person tech contact
    • x-barcelona_intendedusestring
      Intended use for domain name
    • x-barcelona_trademarkidstring
      Local Trademark ID.
    • x-ca_business_entity_typestring
      business entity type
    • x-ca_legaltypestring
      owner's legal type
    • x-ca_official_repstring
      official representative (for LGR)
    • x-ca_official_rep_capacitystring
      official representative capacity (for LGR)
    • x-ca_owner_namestring
      owner name (deprecated)
    • x-cat_intendedusestring
      Intended use for domain name
    • x-coop_sponsorstring
      Coop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
    • x-cy_reg_identity_nostring
      id card number or passport number if physical person, else registration number (SIREN)
    • x-document_countrystring
      Registrant's country which issued the document
    • x-document_typestring
      Registrant's document type
    • x-document_valuestring
      Registrant's document number
    • x-es_admin_identificationstring
      id of the admin contact
    • x-es_admin_tipo_identificationstring
      type of id for admin
    • x-es_bill_identificationstring
      id of the bill contact
    • x-es_bill_tipo_identificationstring
      type of id for bill
    • x-es_identificationstring
      id of the contact (deprecated)
    • x-es_legalformstring
      legal form of the organization (deprecated)
    • x-es_owner_identificationstring
      id of the owner contact
    • x-es_owner_legalformstring
      legal form of the owner organization
    • x-es_owner_tipo_identificationstring
      type of id for owner
    • x-es_tech_identificationstring
      id of the tech contact
    • x-es_tech_tipo_identificationstring
      type of id for tech
    • x-es_tipo_identificationstring
      type of id (deprecated)
    • x-eu_country_of_citizenshipstring
      Country of citizenship for registrant
    • x-eus_intendedusestring
      Intended use for domain name
    • x-fi_business_numberstring
      Registrant's identification number for a moral person
    • x-fi_ident_numberstring
      Registrant's identification number for a physical person
    • x-fi_isfinishstring
      Whether or not domain registrant is Finish, for a physical or moral person
    • x-fi_organization_typestring
      Registrant organization type for a moral person
    • x-gal_intendedusestring
      Intended use for domain name
    • x-hk_registrant_birth_datestring
      owner's birth date (YYYY-MM-DD)
    • x-hk_registrant_document_numberstring
      number of the above document
    • x-hk_registrant_document_origin_countrystring
      country code (FR, GB, US…) of the origin country of the above document
    • x-hk_registrant_document_typestring
      owner's document type
    • x-hk_registrant_other_document_typestring
      mandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
    • x-hr_ident_numberstring
      Croatian identification number (OIB)
    • x-hr_non_eu_pm_business_numberstring
      Local business registration number
    • x-hu_idnumberstring
      id card number or passport number of the physical person
    • x-hu_owner_vatidstring
      vatid of the moral person
    • x-ie_registrant_cro_numberstring
      Companies Registration Office in case the registrant type ie COM
    • x-ie_registrant_supporting_numberstring
      Identifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
    • x-ie_registrant_typestring
      The contact's Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
    • x-il_registrant_company_typestring
    • x-it_nationalitystring
      nationality of the owner
    • x-it_pinstring
      owner's Italian fiscal code or the number of an identity document
    • x-it_registrant_entity_typestring
      owner entity type
    • x-jobs_websitestring
      owner website information (deprecated)
    • x-kr_reg_identity_nostring
      Registrant's Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
    • x-lt_registrant_legal_idstring
      owner legal entity identification code
    • x-ltda_authoritystring
      authority where the contact is registred
    • x-ltda_licensenumberstring
      licence number
    • x-lv_idnumberstring
      id card number or passport number if physical person, else registration number (SIREN)
    • x-madrid_intendedusestring
      Intended use for domain name
    • x-my_admin_contact_passwordstring
      Admin contact password record (For transfer only)
    • x-my_admin_contact_usernamestring
      Admin contact username as per Whois record (For transfer only)
    • x-my_business_numberstring
      Registrant's Business Number
    • x-my_organization_typestring
      Registrant's Organization Type
    • x-no_registrant_identitystring
      Personal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits)
    • x-nu_registrant_idnumberstring
      Registrant's id number or organization number
    • x-nu_registrant_vatidstring
      vatid of the moral person
    • x-nyc_extcontactstring
      Gandi Handle of the EXTContact
    • x-pro_authoritystring
      authority where the contact is registred
    • x-pro_authoritywebsitestring
      link to the registration authority
    • x-pro_licensenumberstring
      licence number
    • x-pro_professionstring
      contact profession
    • x-promopixel_company_serialstring
      owner
    • x-pt_arbitrationstring
      true (default) or false as answer to whether or not the registry arbitration is accepted
    • x-pt_registrant_vatidstring
      owner's VAT for company or ID card number for individual
    • x-pt_roidstring
      roid of the domain (in transfer process only)
    • x-pt_tech_vatidstring
      tech's VAT for company or ID card number for individual
    • x-quebec_intendedusestring
      Intended use for domain name
    • x-radio_intendedusestring
      Intended use for domain name
    • x-ro_registrant_idnumberstring
      id card number or passport number if physical person, else registration number (SIREN)
    • x-rs_company_numberstring
      The company's number for Moral Person.
    • x-rs_reg_identity_nostring
      Registrant's Residence Registration No. (13-digit)
    • x-rs_reg_tax_nostring
      Registrant's GST/VAT number
    • x-ru_registrant_birth_datestring
      owner's birth date (YYYY-MM-DD)
    • x-ru_registrant_kppstring
      Territory-linked taxpayer number for PM registrants
    • x-ru_registrant_passport_datastring
      The number of the identity proof
    • x-ru_registrant_tinstring
      Taxpayer identification number for PM registrants
    • x-scot_intendedusestring
      Intended use for domain name
    • x-se_ident_numberstring
      Swedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
    • x-se_registrant_vatidstring
      vatid of the moral person
    • x-sg_idnumberstring
      Registrant's id number
    • x-sport_intendedusestring
      Intended use for domain name
    • x-srl_authoritystring
      authority where the contact is registred
    • x-srl_licensenumberstring
      licence number
    • x-swiss_enterpriseidstring
      Swiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
    • x-swiss_intendedusestring
      Intended use for domain name
    • x-travel_uinstring
      an Unique Identification Number (deprecated)
    • x-tw_company_numberstring
      The company's number for Moral Person.
    • x-uk_co_nostring
      The registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
    • x-uk_contact_typestring
      Contact type as defined at NOMINET
    • x-us_app_purposestring
      Domain application purpose
    • x-us_nexus_categorystring
      Applicant category
    • x-xxx_membership_contactstring
      owner contact membership ID, obtained on the xxx registry website.
    • x-xxx_sponsored_communitystring
      yes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community

Contact Extra Parameters

This parameters need to be added on contacts for operations like domain creation or transfer. The parameter you need to send depens on the domain's extension.
  • object

    With the following properties:

    Required
    • birth_citystring
      contact birth city
    • birth_countrystring
      contact birth country
    • birth_datestring
      contact birth date (YYYY-MM-DD)
    • birth_departmentstring
      contact birth department … or zipcode, use 99 if contact was born outside of France / DOM/TOM
    • brand_numberstring
      company brand number
    • dunsstring
      contact duns number
    • waldecstring
      contact waldec number
    • x-aero_ens_authidstring
      aero id (you can apply for an .aero id on http://www.information.aero/)
    • x-aero_ens_authkeystring
      aero password
    • x-au_registrant_id_numberstring
    • x-au_registrant_id_typestring
      owner's document type
    • x-az_admin_pp_idstring
      ID number for a Physical Person admin contact
    • x-az_billing_pp_idstring
      ID number for a Physical Person billing contact
    • x-az_registrant_company_numberstring
      Company number for a Moral Person registrant contact
    • x-az_registrant_pp_idstring
      ID number for a Physical Person registrant contact
    • x-az_tech_pp_idstring
      ID number for a Physical Person tech contact
    • x-barcelona_intendedusestring
      Intended use for domain name
    • x-barcelona_trademarkidstring
      Local Trademark ID.
    • x-ca_business_entity_typestring
      business entity type
    • x-ca_legaltypestring
      owner's legal type
    • x-ca_official_repstring
      official representative (for LGR)
    • x-ca_official_rep_capacitystring
      official representative capacity (for LGR)
    • x-ca_owner_namestring
      owner name (deprecated)
    • x-cat_intendedusestring
      Intended use for domain name
    • x-coop_sponsorstring
      Coop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
    • x-cy_reg_identity_nostring
      id card number or passport number if physical person, else registration number (SIREN)
    • x-document_countrystring
      Registrant's country which issued the document
    • x-document_typestring
      Registrant's document type
    • x-document_valuestring
      Registrant's document number
    • x-es_admin_identificationstring
      id of the admin contact
    • x-es_admin_tipo_identificationstring
      type of id for admin
    • x-es_bill_identificationstring
      id of the bill contact
    • x-es_bill_tipo_identificationstring
      type of id for bill
    • x-es_identificationstring
      id of the contact (deprecated)
    • x-es_legalformstring
      legal form of the organization (deprecated)
    • x-es_owner_identificationstring
      id of the owner contact
    • x-es_owner_legalformstring
      legal form of the owner organization
    • x-es_owner_tipo_identificationstring
      type of id for owner
    • x-es_tech_identificationstring
      id of the tech contact
    • x-es_tech_tipo_identificationstring
      type of id for tech
    • x-es_tipo_identificationstring
      type of id (deprecated)
    • x-eu_country_of_citizenshipstring
      Country of citizenship for registrant
    • x-eus_intendedusestring
      Intended use for domain name
    • x-fi_business_numberstring
      Registrant's identification number for a moral person
    • x-fi_ident_numberstring
      Registrant's identification number for a physical person
    • x-fi_isfinishstring
      Whether or not domain registrant is Finish, for a physical or moral person
    • x-fi_organization_typestring
      Registrant organization type for a moral person
    • x-gal_intendedusestring
      Intended use for domain name
    • x-hk_registrant_birth_datestring
      owner's birth date (YYYY-MM-DD)
    • x-hk_registrant_document_numberstring
      number of the above document
    • x-hk_registrant_document_origin_countrystring
      country code (FR, GB, US…) of the origin country of the above document
    • x-hk_registrant_document_typestring
      owner's document type
    • x-hk_registrant_other_document_typestring
      mandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
    • x-hr_ident_numberstring
      Croatian identification number (OIB)
    • x-hr_non_eu_pm_business_numberstring
      Local business registration number
    • x-hu_idnumberstring
      id card number or passport number of the physical person
    • x-hu_owner_vatidstring
      vatid of the moral person
    • x-ie_registrant_cro_numberstring
      Companies Registration Office in case the registrant type ie COM
    • x-ie_registrant_supporting_numberstring
      Identifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
    • x-ie_registrant_typestring
      The contact's Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
    • x-il_registrant_company_typestring
    • x-it_nationalitystring
      nationality of the owner
    • x-it_pinstring
      owner's Italian fiscal code or the number of an identity document
    • x-it_registrant_entity_typestring
      owner entity type
    • x-jobs_websitestring
      owner website information (deprecated)
    • x-kr_reg_identity_nostring
      Registrant's Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
    • x-lt_registrant_legal_idstring
      owner legal entity identification code
    • x-ltda_authoritystring
      authority where the contact is registred
    • x-ltda_licensenumberstring
      licence number
    • x-lv_idnumberstring
      id card number or passport number if physical person, else registration number (SIREN)
    • x-madrid_intendedusestring
      Intended use for domain name
    • x-my_admin_contact_passwordstring
      Admin contact password record (For transfer only)
    • x-my_admin_contact_usernamestring
      Admin contact username as per Whois record (For transfer only)
    • x-my_business_numberstring
      Registrant's Business Number
    • x-my_organization_typestring
      Registrant's Organization Type
    • x-no_registrant_identitystring
      Personal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits)
    • x-nu_registrant_idnumberstring
      Registrant's id number or organization number
    • x-nu_registrant_vatidstring
      vatid of the moral person
    • x-nyc_extcontactstring
      Gandi Handle of the EXTContact
    • x-pro_authoritystring
      authority where the contact is registred
    • x-pro_authoritywebsitestring
      link to the registration authority
    • x-pro_licensenumberstring
      licence number
    • x-pro_professionstring
      contact profession
    • x-promopixel_company_serialstring
      owner
    • x-pt_arbitrationstring
      true (default) or false as answer to whether or not the registry arbitration is accepted
    • x-pt_registrant_vatidstring
      owner's VAT for company or ID card number for individual
    • x-pt_roidstring
      roid of the domain (in transfer process only)
    • x-pt_tech_vatidstring
      tech's VAT for company or ID card number for individual
    • x-quebec_intendedusestring
      Intended use for domain name
    • x-radio_intendedusestring
      Intended use for domain name
    • x-ro_registrant_idnumberstring
      id card number or passport number if physical person, else registration number (SIREN)
    • x-rs_company_numberstring
      The company's number for Moral Person.
    • x-rs_reg_identity_nostring
      Registrant's Residence Registration No. (13-digit)
    • x-rs_reg_tax_nostring
      Registrant's GST/VAT number
    • x-ru_registrant_birth_datestring
      owner's birth date (YYYY-MM-DD)
    • x-ru_registrant_kppstring
      Territory-linked taxpayer number for PM registrants
    • x-ru_registrant_passport_datastring
      The number of the identity proof
    • x-ru_registrant_tinstring
      Taxpayer identification number for PM registrants
    • x-scot_intendedusestring
      Intended use for domain name
    • x-se_ident_numberstring
      Swedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
    • x-se_registrant_vatidstring
      vatid of the moral person
    • x-sg_idnumberstring
      Registrant's id number
    • x-sport_intendedusestring
      Intended use for domain name
    • x-srl_authoritystring
      authority where the contact is registred
    • x-srl_licensenumberstring
      licence number
    • x-swiss_enterpriseidstring
      Swiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
    • x-swiss_intendedusestring
      Intended use for domain name
    • x-travel_uinstring
      an Unique Identification Number (deprecated)
    • x-tw_company_numberstring
      The company's number for Moral Person.
    • x-uk_co_nostring
      The registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
    • x-uk_contact_typestring
      Contact type as defined at NOMINET
    • x-us_app_purposestring
      Domain application purpose
    • x-us_nexus_categorystring
      Applicant category
    • x-xxx_membership_contactstring
      owner contact membership ID, obtained on the xxx registry website.
    • x-xxx_sponsored_communitystring
      yes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community

Country Codes

CodeName
ACAscension
ADAndorra
AEUnited Arab Emirates
AFAfghanistan
AGAntigua and Barbuda
AIAnguilla
ALAlbania
AMArmenia
ANNetherlands Antilles
AOAngola
AQAntarctica
ARArgentina
ASAmerican Samoa
ATAustria
AUAustralia
AWAruba
AXAland Islands
AZAzerbaijan
BABosnia and Herzegovina
BBBarbados
BDBangladesh
BEBelgium
BFBurkina Faso
BGBulgaria
BHBahrain
BIBurundi
BJBenin
BLSaint Barthelemy
BMBermuda
BNBrunei
BOBolivia
BQBonaire, Sint Eustatius and Saba
BRBrazil
BSBahamas
BTBhutan
BVBouvet Island
BWBotswana
BYBelarus
BZBelize
CACanada
CCIslands Cocos (Keeling) Islands
CDCongo Zaire
CFCentral African Republic
CGCongo
CHSwitzerland
CIIvory Coast
CKCook Islands
CLChile
CMCameroon
CNChina
COColombia
CRCosta Rica
CUCuba
CVCape Verde
CWCuracao
CXChristmas Island
CYCyprus
CZCzech Republic
DEGermany
DJDjibouti
DKDenmark
DMDominica
DODominican (Republic)
DZAlgeria
ECEcuador
EEEstonia
EGEgypt
EHWestern Sahara
ERErytrea
ESSpain
ETEthiopia
FIFinland
FJFiji
FKFalkland Islands
FMMicronesia
FOFaeroe Islands
FRFrance
GAGabon
GBUnited Kingdom
GDGrenada
GEGeorgia
GFFrench Guiana
GGGuernsey
GHGhana
GIGibraltar
GLGreenland
GMGambia
GNGuinea
GPGuadeloupe
GQEquatorial Guinea
GRGreece
GSSouth Georgia and the South Sandwich Islands
GTGuatemala
GUGuam
GWGuinea-Bissau
GYGuyana
HKHong Kong
HMAustralia Heard Island and McDonald Islands
HNHonduras
HRCroatia
HTHaiti
HUHungary
IDIndonesia
IEIreland
ILIsrael
IMIsle of Man
INIndia
IOBritish Indian Ocean Territory
IQIraq
IRIran (Islamic Rep. of)
ISIceland
ITItaly
JEJersey (Islands)
JMJamaica
JOJordan
JPJapan
KEKenya
KGKyrgystan
KHCambodia
KIKiribati
KMComoros
KNSaint Kitts and Nevis
KPKorea (Democratic People's Republic of)
KRKorea (Republic of)
KWKuwait
KYCayman (Islands)
KZKazakhstan
LALaos (People's Democratic Republic of)
LBLebanon
LCSaint Lucia
LILiechstenstein
LKSri Lanka
LRLiberia
LSLesotho
LTLithuania
LULuxembourg
LVLatvia
LYLibya
MAMorocco
MCMonaco
MDMoldova
MEMontenegro
MFSaint Martin (French Part)
MGMadagascar
MHMarshall Islands
MKMacedonia (F.Y.R.O.M.)
MLMali
MMMyanmar
MNMongolia
MOMacao
MPSaipan
MQMartinique
MRMauritania
MSMontserrat
MTMalta
MUMauritius
MVMaldives
MWMalawi
MXMexico
MYMalaysia
MZMozambique
NANamibia
NCNew Caledonia
NENiger
NFNorfolk Island
NGNigeria
NINicaragua
NLNetherlands
NONorway
NPNepal
NRNauru
NUNiue
NZNew Zealand
OMOman
PAPanama
PEPeru
PFFrench Polynesia
PGPapua New Guinea
PHPhilippines
PKPakistan
PLPoland
PMSaint Pierre et Miquelon
PNPitcairn
PRPuerto Rico
PSPalestine
PTPortugal
PWPalau
PYParaguay
QAQatar
REReunion
RORomania
RSSerbia
RURussia
RWRwanda
SASaudi Arabia
SBSolomon
SCSeychelles
SDSudan
SESweden
SGSingapore
SHSaint Helena
SISlovenia
SJSvalbard and Jan Mayen
SKSlovak (Republic)
SLSierra Leone
SMSan Marino
SNSenegal
SOSomalia
SRSurinam
SSSouth Sudan
STSao Tome and Principe
SVEl Salvador
SXSaint Martin (Dutch Part)
SYSyria
SZSwaziland
TCTurks and Caicos Islands
TDChad
TFFrench Southern Territories
TGTogo
THThailand
TJTajikistan (Republic of)
TKTokelau
TLTimor-Leste
TMTurkmenistan
TNTunisia
TOTonga
TPEast Timor
TRTurkey
TTTrinidad and Tobago
TVTuvalu
TWTaiwan
TZTanzania
UAUkraine
UGUganda
USUnited States of America
UYUruguay
UZUzbekistan
VAHoly See (Vatican City State)
VCSaint Vincent and the Grenadines
VEVenezuela
VGBritish Virgin Islands (Tortola)
VIUnited States Virgin Islands
VNVietnam
VUVanuatu
WFWallis and Futuna
WSWestern Samoa
YEYemen (Rep. of)
YTMayotte
ZASouth Africa
ZMZambia
ZWZimbabwe
ZZEquatorial Kundu