ACME API

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

Gandi ACME Management API

Introduction

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

Catalog List

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

get List catalog prices of quantity of one domain

Request

Query Parameters
  • Required
    • country ⁠string
    • currency ⁠string
    • duration ⁠string
    • grid ⁠string
    • process ⁠string
    • provider ⁠string
    • sharing_id ⁠string
    • validation_type ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Body
  • application/json
    ⁠array

    Of items of type:

    • object
      Price return from billing library

      With the following properties:

      • currency ⁠string
      • duration_unit ⁠string
      • grid ⁠string

        One of: "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T"

      • max_duration ⁠integer
      • min_duration ⁠integer
      • price_after_taxes ⁠string
      • price_before_taxes ⁠string
      • process ⁠string

        One of: "add_fqdn", "add_wildcard"

      • product ⁠object

        With the following properties:

        • name ⁠string
        • params ⁠object

          With the following properties:

          • provider ⁠string

            One of: "sectigo", "digicert"

            ACME providers enumeration
          • validation_type ⁠string

            One of: "dv", "ov"

      • tax_rate ⁠string
      • taxes ⁠array

        Of items of type:

        • object

          With the following properties:

          • label ⁠string
          • name ⁠string
          • rate ⁠string
          • type ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Prices list

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

post List prices with filters, according to specific domain list

Request

Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123
Body
  • application/json
    ⁠object

    With the following properties:

    Required
    • country ⁠string
    • currency ⁠string
    • domains ⁠array[ string ]

      Minimum items: 1

    • duration ⁠string
    • grid ⁠string
    • process ⁠string
    • provider ⁠string
    • validation_type ⁠string

Responses

200

Body
  • application/json
    ⁠array

    Of items of type:

    • object

      With the following properties:

      • currency ⁠string
      • duration_unit ⁠string
      • grid ⁠string

        One of: "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T"

      • max_duration ⁠integer
      • min_duration ⁠integer
      • price_after_taxes ⁠string
      • price_before_taxes ⁠string
      • process ⁠string

        One of: "add_fqdn", "add_wildcard"

      • product ⁠object

        With the following properties:

        • name ⁠string
        • params ⁠object

          With the following properties:

          • provider ⁠string

            One of: "sectigo", "digicert"

            ACME providers enumeration
          • validation_type ⁠string

            One of: "dv", "ov"

      • quantity ⁠integer
      • tax_rate ⁠string
      • taxes ⁠array

        Of items of type:

        • object

          With the following properties:

          • label ⁠string
          • name ⁠string
          • rate ⁠string
          • type ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Subscriptions Create and List

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

get List subscriptions for a given sharing_id

Request

Query Parameters
  • Required
    • created_at ⁠string
    • ends_at ⁠string
    • name ⁠string
    • provider ⁠string
    • sharing_id ⁠string
    • status ⁠string
    • validation_type ⁠string
    • years ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Headers
    • X-Total-Count ⁠string
Body
  • application/json
    ⁠array

    Of items of type:

    • object

      With the following properties:

      • created_at ⁠string
      • eab_hmac ⁠string
      • eab_id ⁠string
      • ends_at ⁠string
      • name ⁠string
      • provider ⁠string
      • server_url ⁠string
      • status ⁠string
      • subscription_id ⁠string
      • validation_type ⁠string
      • years ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

post Create a partial subscription, waiting for billing task to be paid

Request

Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123
Body
  • application/json
    ⁠object

    With the following properties:

    Required
    • country ⁠string
    • currency ⁠string

      Default: "EUR"

    • domains ⁠array[ string ]

      Minimum items: 1

    • duration ⁠integer

      Default: 1

      duration in years
    • grid ⁠string

      Default: "A"

    • name ⁠string

      Default: "FIXME"

      Minimum length: 1

      Maximum length: 200

    • provider ⁠string

      One of: "sectigo", "digicert"

      ACME providers enumeration
    • validation_type ⁠string

      One of: "dv", "ov"

Responses

200

Headers
    • Content-Location ⁠string
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

    • message ⁠string

      Default: "Request 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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Subscriptions Modify and Delete

https://api.gandi.net/v5/acme/subscriptions/{subscription_id}

get Returns a single account associated with the subscription_id and the account_id

Request

URI Parameters
    • subscription_id ⁠string
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • created_at ⁠string
    • eab_hmac ⁠string
    • eab_id ⁠string
    • ends_at ⁠string
    • name ⁠string
    • provider ⁠string
    • server_url ⁠string
    • status ⁠string
    • subscription_id ⁠string
    • validation_type ⁠string
    • years ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

patch Changes the name of the subscription

Request

URI Parameters
    • subscription_id ⁠string
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123
Body
  • application/json
    ⁠object

    With the following properties:

    Required
    • name ⁠string

      Minimum length: 1

      Maximum length: 200

Responses

200

Headers
    • Content-Location ⁠string
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

    • message ⁠string

      Default: "Request 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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

delete Delete the subscription

Request

URI Parameters
    • subscription_id ⁠string
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Body
  • application/json
    ⁠string

    Default: ""

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Account List

https://api.gandi.net/v5/acme/subscriptions/{subscription_id}/accounts

get List all accounts linked to a subscription

Request

URI Parameters
    • subscription_id ⁠string
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Headers
    • X-Total-Count ⁠string
Body
  • application/json
    ⁠array

    Of items of type:

    • object

      With the following properties:

      • created_at ⁠string
      • deleted_at ⁠string
      • external_id ⁠string
      • id ⁠string
      • ip ⁠string
      • last_activity ⁠string
      • status ⁠string
      • subscription_id ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Account Info

https://api.gandi.net/v5/acme/subscriptions/{subscription_id}/accounts/{account_id}

get Returns a single account associated with the subscription_id and the account_id

Request

URI Parameters
    • subscription_id ⁠string
    • account_id ⁠string
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • created_at ⁠string
    • deleted_at ⁠string
    • external_id ⁠string
    • id ⁠string
    • ip ⁠string
    • last_activity ⁠string
    • status ⁠string
    • subscription_id ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Domains List

https://api.gandi.net/v5/acme/subscriptions/{subscription_id}/domains

get List all domains on a subscription

Request

URI Parameters
    • subscription_id ⁠string
Query Parameters
  • Required
    • domain ⁠string
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Headers
    • X-Total-Count ⁠string
Body
  • application/json
    ⁠array

    Of items of type:

    • object

      With the following properties:

      • created_at ⁠string
      • deleted_at ⁠string
      • hostname ⁠string
      • hostname_ulabel ⁠string
      • is_wildcard ⁠string
      • status ⁠string
      • subscription_id ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

patch Changes the domains of the subscription

Request

URI Parameters
    • subscription_id ⁠string
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123
Body
  • application/json
    ⁠object

    With the following properties:

    Required
    • country ⁠string
    • currency ⁠string

      Default: "EUR"

    • domains_to_add ⁠array[ string ]
    • domains_to_delete ⁠array[ string ]
    • grid ⁠string

      Default: "A"

    • provider ⁠string

      Default: "sectigo"

    • validation_type ⁠string

      Default: "dv"

Responses

200

Headers
    • Content-Location ⁠string
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

    • message ⁠string

      Default: "Request 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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Domain Info

https://api.gandi.net/v5/acme/subscriptions/{subscription_id}/domains/{domain_id}

get Returns a single domain linked to the right subscription_id and domain_id association

Request

URI Parameters
    • subscription_id ⁠string
    • domain_id ⁠integer
Query Parameters
  • Required
    • sharing_id ⁠string
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • created_at ⁠string
    • deleted_at ⁠string
    • hostname ⁠string
    • hostname_ulabel ⁠string
    • is_wildcard ⁠string
    • status ⁠string
    • subscription_id ⁠string

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:

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

401

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

    With the following properties:

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

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:

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

Secured by

Http Authorization Scheme

This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.

Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Bearer for access token.
      Example: Bearer pat_abc-123

Last modification: Sep. 1st 2026