Domain API

URI Parameters

• • domain ⁠string

Query String

• Optional

  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

• Required

  • Authorization ⁠string
    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-Run ⁠integer
    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

  • owner ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • icann_contract_accept ⁠boolean

      Default: false

      To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules.
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not "individual".
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string

  Optional

  • admin ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • icann_contract_accept ⁠boolean

      Default: false

      To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules.
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not "individual".
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string
  • bill ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • icann_contract_accept ⁠boolean

      Default: false

      To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules.
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not "individual".
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string
  • tech ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • icann_contract_accept ⁠boolean

      Default: false

      To unlock the Email address field and make changes, set this field to true to authorize the registrar, Gandi, to be the "Designated Agent" under ICANN rules.
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not "individual".
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string
  Example:

  {
    "owner": {
      "city": "Paris",
      "given": "Alice",
      "family": "Doe",
      "zip": "75001",
      "country": "FR",
      "streetaddr": "5 rue neuve",
      "data_obfuscated": true,
      "mail_obfuscated": true,
      "phone": "+33.123456789",
      "state": "FR-IDF",
      "type": "individual",
      "email": "alice@example.org"
    }
  }

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

  • errors ⁠array
    A list of all the errors encountered during validation.

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

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

        The field's location in the HTTP response.
      • name ⁠string
        The xpath of the field.

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string

Query String

• Optional

  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

• Required

  • Authorization ⁠string
    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:

  • created_at ⁠datetime
  • params ⁠object

    With the following properties:

    Optional

    • answer_new_owner ⁠string
    • answer_old_owner ⁠string
    • inner_step ⁠string
    • new_owner_email ⁠string
    • old_admin_email ⁠string
    • old_owner_email ⁠string
  • step ⁠string
  • step_nb ⁠integer
  • updated_at ⁠datetime

  Optional

  • date_start ⁠string
  • errortype ⁠string
  • errortype_label ⁠string
  • foa ⁠array

    Of items of type:

    • object

      With the following properties:

      • answer ⁠string
      • email ⁠string
  • inner_step ⁠string
  Example:

  {
    "created_at": "2021-01-20T00:00:00Z",
    "updated_at": "2021-01-20T00:00:00Z",
    "inner_step": "checking_foa_response",
    "step": "WAIT",
    "step_nb": 2,
    "params": {
      "answer_new_owner": "T",
      "answer_old_owner": "T",
      "inner_step": "checking_foa_response",
      "new_owner_email": "alice@example.org",
      "old_owner_email": "john@doe.com"
    }
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string

Headers

• Required

  • Authorization ⁠string
    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

  • email ⁠string
  Example:

  {
    "email": "alice@example.org"
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Query String

• Required

  • name ⁠string
    domain name to query

  Optional

  • country ⁠string
    ISO country code for which taxes are to be applied
  • currency ⁠string
    request price for a specific ISO currency code
  • duration_unit ⁠string
    define the unit for max_duration
  • extension ⁠string
    query a specific extension for product options
  • grid ⁠string
    request price for a specific rate
  • lang ⁠string
    language code
  • max_duration ⁠integer
    set a limit on the duration range for returned prices
  • period ⁠string
    specific registration period to query
  • processes ⁠array[ string ]

    Default: ["create"]

    list of at least 1 process for which pricing is to be made
  • sharing_id ⁠string
    Organization for which the pricing is to be made. See the reference.

?name=example.com

?name=example.com&processes=create&processes=transfer&grid=C

Headers

• Required

  • Authorization ⁠string
    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:

  • currency ⁠string
  • grid ⁠string
  • products ⁠array

    Of items of type:

    • object

      With the following properties:

      • name ⁠string
        product name
      • prices ⁠array

        Of items of type:

        • object

          With the following properties:

          • duration_unit ⁠string
            time unit for duration
          • max_duration ⁠integer
            maximum duration for which this price unit applies
          • min_duration ⁠integer
            minimum duration for which this price unit applies
          • price_after_taxes ⁠number
            pricing after tax is applied
          • price_before_taxes ⁠number
            pricing before tax is applied

          Optional

          • discount ⁠boolean
            indicate if a discount is active on this price unit
          • normal_price_after_taxes ⁠number
            pricing after tax is applied, when no discount applies
          • normal_price_before_taxes ⁠number
            pricing before tax is applied, when no discount applies
          • options ⁠object

            With the following properties:

            Optional

            • period ⁠string
              registration period
          • type ⁠string
            pricing type involved
      • status ⁠string

        product availability status. NOTE: This availability status is only relevant when the query is related to "processes=create". Status answer should be ignored when "processes" is set to something else. Possible values are:

        • available: Domain name is 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
      • taxes ⁠array

        Of items of type:

        • object

          With the following properties:

          • name ⁠string
            name of the tax
          • rate ⁠number
            rate in percent
          • type ⁠string
            type of tax

      Optional

      • periods ⁠array

        Of items of type:

        • object

          With the following properties:

          • name ⁠string
            name of the registration period
          • starts_at ⁠datetime
            start of the registration period

          Optional

          • ends_at ⁠datetime
            end of the registration period if it's not General Availability (golive)
      • process ⁠string
        process for this price
  • taxes ⁠array

    Of items of type:

    • object

      With the following properties:

      • name ⁠string
        name of the tax
      • rate ⁠number
        rate in percent
      • type ⁠string
        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"
      }
    ]
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Query String

• Optional

  • fqdn ⁠string
    Filters the list by domain name, with optional patterns.
    Example: example.net
    Example: example.*
    Example: *example.com
  • nameserver ⁠string

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

    Used to filter the type of nameservers
  • page ⁠integer

    Default: 1

    Minimum: 1

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

    Minimum: 1

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

    Default: "fqdn"

    Used to specify how you want the results sorted.
  • tld ⁠string
    Used to filter by just the extension.

Headers

• Required

  • Authorization ⁠string
    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

  • Accept ⁠string
    When passed text/csv value, this route will return a CSV-formatted response.

Headers

• • Total-Count ⁠integer
    Total number of items.

  Optional

  • Filtered-Count ⁠integer
    On a filtered list, this is the number of matching items.
  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • autorenew ⁠boolean
      Automatic renewal status. Learn more about automatic renewal.
    • dates ⁠object
      Domain's life cycle dates.

      With the following properties:

      • registry_created_at ⁠datetime
      • updated_at ⁠datetime

      Optional

      • authinfo_expires_at ⁠datetime
      • created_at ⁠datetime
      • deletes_at ⁠datetime
      • hold_begins_at ⁠datetime
      • hold_ends_at ⁠datetime
      • pending_delete_ends_at ⁠datetime
      • registry_ends_at ⁠datetime
      • renew_begins_at ⁠datetime
      • restore_ends_at ⁠datetime
    • domain_owner ⁠string
    • fqdn ⁠string
      Fully qualified domain name, written in its native alphabet (IDN).
    • fqdn_unicode ⁠string
      Fully qualified domain name, written in unicode (learn more).
    • href ⁠string
      Link to domain details.
    • id ⁠string
      UUID
    • nameserver ⁠object

      With the following properties:

      • current ⁠string

      Optional

      • hosts ⁠array[ string ]
    • orga_owner ⁠string
    • owner ⁠string
    • status ⁠array

      Of items of type:

      • string

        One of: "clientHold", "clientUpdateProhibited", "clientTransferProhibited", "clientDeleteProhibited", "clientRenewProhibited", "serverHold", "pendingTransfer", "serverTransferProhibited"

        Information on the following domain statuses can be found in our general documentation.
    • tld ⁠string

    Optional

    • sharing_id ⁠string
      UUID
    • tags ⁠array[ 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.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Query String

• Optional

  • sharing_id ⁠string
    Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.

Headers

• Required

  • Authorization ⁠string
    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-Run ⁠integer
    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

  • fqdn ⁠string
  • owner ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not 0.
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string

  Optional

  • admin ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not 0.
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string
  • bill ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not 0.
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string
  • claims ⁠string
    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
  • currency ⁠string

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

  • duration ⁠integer

    Minimum: 1

    Maximum: 10

  • enforce_premium ⁠boolean
    Must be set to true if the domain is a premium domain.
  • extra_parameters ⁠object
    Extra parameters needed for some extensions. See this list for possible values.
  • lang ⁠string
    ISO-639-2 language code of the domain, required for some IDN domains.
  • nameservers ⁠array[ string ]
    List of nameservers. Gandi's LiveDNS nameservers are used if omitted.
  • nameservers_ips ⁠object
    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"
      ]
    }

  • price ⁠number
  • resellee_id ⁠string
  • smd ⁠string
    Contents of a Signed Mark Data file (used for newgtld sunrises, tld_period must be sunrise)
  • tech ⁠object

    With the following properties:

    Required

    • country ⁠string
      A country code. See the country code list for possible values.
    • email ⁠string
    • family ⁠string
      Contact's family name (usualy the lastname)
    • given ⁠string
      Contact's given name (usualy the firstname)
    • streetaddr ⁠string
    • type ⁠string

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

    Optional

    • brand_number ⁠string
    • city ⁠string
    • data_obfuscated ⁠boolean

      Default: true

      Learn more about WHOIS privacy at Gandi here.
    • extra_parameters ⁠object
      Extra parameters needed for some extensions. See this list for possible values.
    • fax ⁠string
    • jo_announce_number ⁠string
    • jo_announce_page ⁠string
    • jo_declaration_date ⁠string
    • jo_publication_date ⁠string
    • lang ⁠string

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

    • mail_obfuscated ⁠boolean
    • mobile ⁠string
    • orgname ⁠string
      The legal name of the company, association, or public body if the contact type is not 0.
    • phone ⁠string
    • siren ⁠string
    • state ⁠string
      Learn more about state codes here
    • validation ⁠string

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

    • zip ⁠string
  • template_id ⁠string
    Template applied when the process is done. It must be a template ID as you can retrieve it using the Template API.
  • tld_period ⁠string

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

    Learn more about new GTLD and Early Access Periods.
  Example:

  {
    "fqdn": "example.com",
    "duration": 5,
    "owner": {
      "city": "Paris",
      "given": "Alice",
      "family": "Doe",
      "zip": "75001",
      "country": "FR",
      "streetaddr": "5 rue neuve",
      "phone": "+33.123456789",
      "state": "FR-IDF",
      "type": "individual",
      "email": "alice@example.org"
    }
  }

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

  • errors ⁠array
    A list of all the errors encountered during validation.

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

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

        The field's location in the HTTP response.
      • name ⁠string
        The xpath of the field.

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string
    Domain name.

Headers

• Required

  • Authorization ⁠string
    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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string
    Domain name.

Headers

• Required

  • Authorization ⁠string
    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:

  • autorenew ⁠object

    With the following properties:

    • href ⁠string

    Optional

    • dates ⁠array[ datetime ]
    • duration ⁠integer

      Default: 1

    • enabled ⁠boolean

      Default: false

    • org_id ⁠string
      UUID
  • can_tld_lock ⁠boolean
  • contacts ⁠object

    With the following properties:

    • admin ⁠object

      With the following properties:

      • country ⁠string
        A country code. See the country code list for possible values.
      • email ⁠string
      • family ⁠string
        Contact's family name (usualy the lastname)
      • given ⁠string
        Contact's given name (usualy the firstname)
      • same_as_owner ⁠boolean
        Will be true when the contact used is the same as the owner.
      • streetaddr ⁠string
      • type ⁠string

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

      Optional

      • brand_number ⁠string
      • city ⁠string
      • data_obfuscated ⁠boolean
      • extra_parameters ⁠object
        Extra parameters needed for some extensions. See this list for possible values.
      • fax ⁠string
      • jo_announce_number ⁠string
      • jo_announce_page ⁠string
      • jo_declaration_date ⁠string
      • jo_publication_date ⁠string
      • mail_obfuscated ⁠boolean
      • mobile ⁠string
      • orgname ⁠string
        The legal name of the company, association, or public body if the contact type is not 0.
      • phone ⁠string
      • reachability ⁠string

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

        Learn more about reachability here.
      • sharing_id ⁠string
      • siren ⁠string
      • state ⁠string
        Learn more about state codes here
      • validation ⁠string

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

      • zip ⁠string
    • bill ⁠object

      With the following properties:

      • country ⁠string
        A country code. See the country code list for possible values.
      • email ⁠string
      • family ⁠string
        Contact's family name (usualy the lastname)
      • given ⁠string
        Contact's given name (usualy the firstname)
      • same_as_owner ⁠boolean
        Will be true when the contact used is the same as the owner.
      • streetaddr ⁠string
      • type ⁠string

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

      Optional

      • brand_number ⁠string
      • city ⁠string
      • data_obfuscated ⁠boolean
      • extra_parameters ⁠object
        Extra parameters needed for some extensions. See this list for possible values.
      • fax ⁠string
      • jo_announce_number ⁠string
      • jo_announce_page ⁠string
      • jo_declaration_date ⁠string
      • jo_publication_date ⁠string
      • mail_obfuscated ⁠boolean
      • mobile ⁠string
      • orgname ⁠string
        The legal name of the company, association, or public body if the contact type is not 0.
      • phone ⁠string
      • reachability ⁠string

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

        Learn more about reachability here.
      • sharing_id ⁠string
      • siren ⁠string
      • state ⁠string
        Learn more about state codes here
      • validation ⁠string

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

      • zip ⁠string
    • owner ⁠object

      With the following properties:

      • country ⁠string
        A country code. See the country code list for possible values.
      • email ⁠string
      • family ⁠string
        Contact's family name (usualy the lastname)
      • given ⁠string
        Contact's given name (usualy the firstname)
      • streetaddr ⁠string
      • type ⁠string

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

      Optional

      • brand_number ⁠string
      • city ⁠string
      • data_obfuscated ⁠boolean
      • extra_parameters ⁠object
        Extra parameters needed for some extensions. See this list for possible values.
      • fax ⁠string
      • jo_announce_number ⁠string
      • jo_announce_page ⁠string
      • jo_declaration_date ⁠string
      • jo_publication_date ⁠string
      • mail_obfuscated ⁠boolean
      • mobile ⁠string
      • orgname ⁠string
        The legal name of the company, association, or public body if the contact type is not 0.
      • phone ⁠string
      • reachability ⁠string

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

        Learn more about reachability here.
      • sharing_id ⁠string
      • siren ⁠string
      • state ⁠string
        Learn more about state codes here
      • validation ⁠string

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

      • zip ⁠string
    • tech ⁠object

      With the following properties:

      • country ⁠string
        A country code. See the country code list for possible values.
      • email ⁠string
      • family ⁠string
        Contact's family name (usualy the lastname)
      • given ⁠string
        Contact's given name (usualy the firstname)
      • same_as_owner ⁠boolean
        Will be true when the contact used is the same as the owner.
      • streetaddr ⁠string
      • type ⁠string

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

      Optional

      • brand_number ⁠string
      • city ⁠string
      • data_obfuscated ⁠boolean
      • extra_parameters ⁠object
        Extra parameters needed for some extensions. See this list for possible values.
      • fax ⁠string
      • jo_announce_number ⁠string
      • jo_announce_page ⁠string
      • jo_declaration_date ⁠string
      • jo_publication_date ⁠string
      • mail_obfuscated ⁠boolean
      • mobile ⁠string
      • orgname ⁠string
        The legal name of the company, association, or public body if the contact type is not 0.
      • phone ⁠string
      • reachability ⁠string

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

        Learn more about reachability here.
      • sharing_id ⁠string
      • siren ⁠string
      • state ⁠string
        Learn more about state codes here
      • validation ⁠string

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

      • zip ⁠string
  • dates ⁠object
    Domain's life cycle dates.

    With the following properties:

    • registry_created_at ⁠datetime
    • updated_at ⁠datetime

    Optional

    • authinfo_expires_at ⁠datetime
    • created_at ⁠datetime
    • deletes_at ⁠datetime
    • hold_begins_at ⁠datetime
    • hold_ends_at ⁠datetime
    • pending_delete_ends_at ⁠datetime
    • registry_ends_at ⁠datetime
    • renew_begins_at ⁠datetime
    • restore_ends_at ⁠datetime
  • fqdn ⁠string
    Fully qualified domain name, written in its native alphabet (IDN).
  • fqdn_unicode ⁠string
    Fully qualified domain name, written in unicode (learn more).
  • href ⁠string
    Link to domain details.
  • nameservers ⁠array[ string ]

    Minimum items: 1

  • reachability ⁠string

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

  • services ⁠array
    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_space ⁠object

    With the following properties:

    • id ⁠string
      UUID
    • name ⁠string
    • type ⁠string

    Optional

    • reseller ⁠boolean
    • sharing_space ⁠object

      With the following properties:

      • id ⁠string
        UUID
      • name ⁠string
  • status ⁠array

    Of items of type:

    • string

      One of: "clientHold", "clientUpdateProhibited", "clientTransferProhibited", "clientDeleteProhibited", "clientRenewProhibited", "serverHold", "pendingTransfer", "serverTransferProhibited"

      Information on the following domain statuses can be found in our general documentation.
  • tld ⁠string

  Optional

  • authinfo ⁠string
  • id ⁠string
    Domain ID
  • sharing_id ⁠string
    UUID
  • tags ⁠array[ string ]
    List of tags that have been assigned to the domain name.
  • trustee_roles ⁠array

    Of items of type:

    • object

      With the following properties:

      • allow_transferout ⁠boolean
      • editable ⁠boolean
      • name ⁠string

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

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

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string
    Domain name.

Headers

• Required

  • Authorization ⁠string
    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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string
    Domain name.

Headers

• Required

  • Authorization ⁠string
    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

  • enabled ⁠boolean

  Optional

  • duration ⁠integer

    Default: 1

    Minimum: 1

    Maximum: 9

  • org_id ⁠string
  Example:

  {
    "duration": 1,
    "enabled": true
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string
    Domain name.

Headers

• Required

  • Authorization ⁠string
    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:

  • claims ⁠array

    Of items of type:

    • object

      With the following properties:

      • contacts ⁠array
        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

          • cc ⁠string
          • city ⁠string
          • email ⁠string
          • fax ⁠string
          • name ⁠string
          • org ⁠string
          • pc ⁠string
          • phone ⁠string
          • sp ⁠string
          • street ⁠string
      • goods_and_services ⁠string
        A very long string describing the trademark categories
      • holders ⁠array
        Owner(s) of the trademark

        Of items of type:

        • object
          Contact information related to a contact / holder

          With the following properties:

          Optional

          • cc ⁠string
          • city ⁠string
          • email ⁠string
          • fax ⁠string
          • name ⁠string
          • org ⁠string
          • pc ⁠string
          • phone ⁠string
          • sp ⁠string
          • street ⁠string
      • jurisdiction_classes ⁠array

        Of items of type:

        • integer
          List of Nice WIPO class numbers (reference)
      • jurisdiction_country ⁠string

      Optional

      • mark_name ⁠string
  • created_at ⁠string
  • expires_at ⁠string
    Warning each notice is valid for an approximate 48 hours, you will get another value after a few hours
  • fqdn ⁠string
  • fqdn_alabel ⁠string
  • fqdn_ulabel ⁠string
  • notice_id ⁠string
    Notice identifier. This should be sent as the "claims" property to the POST on /domains
  • status ⁠string

    One of: "new", "accepted"

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/josn

  ⁠any
  Expected response when no claim is accociated with this domain

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • domain ⁠string
    Domain name.

Headers

• Required

  • Authorization ⁠string
    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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string