Reference

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

General Documentation for Gandi's Public API

Introduction

Welcome to Gandi's v5 API!

Gandi provides remote RESTful APIs over HTTPS, making it easy to manage your products and build third-party applications.

This document is a complete reference guide to using Gandi's v5 API.

Please note that this API is currently in BETA testing, so care should be taken when used in production.

If you encounter any errors and need assistance, please use our online form to contact our customer support team.

RESTful interface

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

All connections to api.gandi.net must be issued over HTTPS.

Stateless

Gandi's API does not maintain sessions. In other words, a request does not depend on previous requests, only its arguments. It only provides object descriptions.

Authentication

Every request to Gandi's API requires authentication. This is why all our routes require a unique Gandi API Key in its headers. If you don’t have one yet, you can generate your production API key from the API Key Page (in the Security section).

Sharing ID

You can pass one of your organization IDs with the sharing_id query string parameter for some requests. This parameter, unless stated otherwise, serves two purposes:

  • for GET requests on collections, it acts like a filter on returned data.
  • for POST, PATCH, or PUT requests that trigger a payment, it indicates the organization that will pay for the ordered product.

You can retrieve you organization list using the Organization API

API Changelog

2020-01-06

Added
  • Domain API
    • added missing support for sharing_id and dry-run on domain renewal

2019-12-20

Added
  • Mailbox API
    • Support for sharing_id and dry-run in upgrade/downgrade offer.
    • Support for dry-run in mailbox creation

2019-12-06

Added
  • LiveDNS API
    • Automatic snapshots feature: automatic snapshots will be created with any record modification
    • added automatic flag on the snapshot list / info
    • added automatic_snapshots attribute on the /domains/{fqdn} route to disable this feature per-domain

2019-10-31

Added
  • Mailbox API
    • Upgrade / Downgrade mailbox offer

2019-10-22

Added
  • LiveDNS API initial release

2019-10-01

Added
  • Organization API
    • Organization customers list
    • Organization customer creation

2019-08-22

Fixed
  • Billing API
    • Fixed a bug with billing information in some cases

2019-07-15

Added
  • Domain API
    • Support for buying a domain as a reseller for a customer

2019-07-10

Added
  • Domain API
    • Domain list in CSV format with "Accept" header
Changed
  • Domain API
    • Domain renew information (GET) returned schema simplified

2019-07-08

Added
  • Mailbox API
    • Forwarding addresses management

2019-06-24

Added
  • Organization API
    • Organization list
Changed
  • Domain API
    • Domain details and contact list always returns all contacts

2019-05-23

Added
  • Domain API
    • Domain hosts (glue records)
    • Domain nameservers

2019-05-16

Added
  • Dry-Run header support in domain create operation

2019-05-13

Added
  • Organization API
    • Current authenticated user information

2019-05-06

Added
  • Added code examples in various languages for all API methods.

2019-04-10

Added
  • Domain API
    • Domain availability and price check
    • Domain create
    • Domain list and details
    • Domain contacts update
    • Domain autorenew update
    • Domain renew and restore
    • Tld list and info
  • Billing API
    • Account information

2019-02-21

Added
  • Mailbox API initial release