Certificate API

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

Gandi Certificate Management API

DCV parameters

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

post Retrieve DCV parameters

Get parameters for DCV (Domain Control Validation). DCV is a security check that validates/grants access to the registred domain name.

Despite being a post method, this route does not perform any change on your existing certificates.

If you want to perform a DCV through DNS, pass the parameter dvc_method with dns.

Request

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
Body
  • application/json
    ⁠object

    With the following properties:

    Optional
    • altnames ⁠array[ string ]
      Alt Name list, when the certificate package permits it
    • csr ⁠string
      Certificate Signing Request
    • dcv_method ⁠string

      One of: "email", "dns", "file", "http", "https"

      The certificate validation method
    • package ⁠string
      Certificate package name as returned in the package list route.

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • dcv_method ⁠string

      One of: "email", "dns", "file", "http", "https"

      The certificate validation method
    • fqdns ⁠array[ string ]
    • md5 ⁠string
    • sha256 ⁠string
    Optional
    • messages ⁠array[ string ]
    • raw_messages ⁠array[ array[ string ] ]
    • unique_value ⁠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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Certificate Create and List

https://api.gandi.net/v5/certificate/issued-certs

get List certificates

This route returns a list of certificates handled by your organizations.

Request

Query String
  • Optional
    • cn ⁠string
      Filters the list by CN name, with optional patterns.
      Example: example.net
      Example: example*
      Example: *example.com
    • covered_cn ⁠string
      Filters the list by certificates valid for a given CN.
    • package ⁠string
      Name of the certificate package.
    • 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.
    • sharing_id ⁠string
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
    • sort_by ⁠string
    • status ⁠string

      One of: "pending", "valid", "revoked", "replaced", "replaced_rev", "expired"

Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

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:

      • altnames ⁠array[ string ]
        Alt Name list, when the certificate package permits it
      • altnames_unicode ⁠array[ string ]
        Alt Name list, when the certificate package permits it
      • cn ⁠string

        Maximum length: 64

        Common Name
      • cn_unicode ⁠string

        Maximum length: 64

        Common Name
      • contact ⁠object

        With the following properties:

        Optional
        • city ⁠string
        • country ⁠string
        • email ⁠string
        • family ⁠string
        • given ⁠string
        • orgname ⁠string
        • state ⁠string
        • streetaddr ⁠string
        • zip ⁠string
      • dates ⁠object

        With the following properties:

        Optional
        • created_at ⁠datetime
        • ends_at ⁠datetime
        • started_at ⁠datetime
        • subscription_ends_at ⁠datetime
        • updated_at ⁠datetime
      • id ⁠string
        UUID
      • package ⁠object

        With the following properties:

        • href ⁠string
        • max_domains ⁠integer
        • name ⁠string
        • name_label ⁠string
        • type ⁠string
        • type_label ⁠string
        • wildcard ⁠boolean
      • software ⁠integer
      • status ⁠string

        One of: "pending", "valid", "revoked", "replaced", "replaced_rev", "expired"

      Optional
      • assumed_name ⁠string
      • business_category ⁠string
      • card_pay_trustlogo ⁠boolean
      • cert ⁠string
      • csr ⁠string
      • dcv_method ⁠string

        One of: "email", "dns", "file", "http", "https"

        The certificate validation method
      • error_msg ⁠string
      • href ⁠string
      • ida ⁠object

        With the following properties:

        Optional
        • email ⁠string
        • fax ⁠string
        • tel ⁠string
      • intermediate ⁠string
      • joi ⁠object

        With the following properties:

        Optional
        • country ⁠string
        • locality ⁠string
        • state ⁠string
      • middleman ⁠object

        With the following properties:

        Optional
        • city ⁠string
        • country ⁠string
        • email ⁠string
        • family ⁠string
        • given ⁠string
        • orgname ⁠string
        • state ⁠string
        • streetaddr ⁠string
        • zip ⁠string
      • owner ⁠string
      • reissuable ⁠boolean
      • renewable ⁠boolean
      • sha_version ⁠integer
      • sharing_id ⁠string
      • state ⁠string
      • state_detail ⁠string
      • stored ⁠boolean
      • trustlogo ⁠boolean
      • trustlogo_token ⁠object

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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

post Create a new certificate

This route creates a new certificate.

The parameters can receive either a CSR or a CN.

Important: All certificates are valid for one year regardless of the duration value. For longer durations, you must update the certificate using PATCH /issued-certs/{id}.

Request

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 Apikey, followed by the user's API Key.
      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
    • package ⁠string
      Certificate package name as returned in the package list route.
    Optional
    • altnames ⁠array[ string ]
      Alt Name list, when the certificate package permits it
    • cn ⁠string

      Maximum length: 64

      Common Name
    • csr ⁠string
      Certificate Signing Request
    • dcv_method ⁠string

      One of: "email", "dns", "file", "http", "https"

      The certificate validation method
    • duration ⁠integer

      Default: 1

      Minimum: 1

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
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.

202

The request has been accepted.
Headers
  • Optional
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

    • href ⁠string
    • id ⁠string
      Certificate ID
    • message ⁠string
      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:

    • 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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Certificate information

https://api.gandi.net/v5/certificate/issued-certs/{id}

get Certificate details

This route is used to retrieve information about a certificate.

Request

URI Parameters
    • id ⁠string
      Certificate ID
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • altnames ⁠array[ string ]
      Alt Name list, when the certificate package permits it
    • altnames_unicode ⁠array[ string ]
      Alt Name list, when the certificate package permits it
    • cn ⁠string

      Maximum length: 64

      Common Name
    • cn_unicode ⁠string

      Maximum length: 64

      Common Name
    • contact ⁠object

      With the following properties:

      Optional
      • city ⁠string
      • country ⁠string
      • email ⁠string
      • family ⁠string
      • given ⁠string
      • orgname ⁠string
      • state ⁠string
      • streetaddr ⁠string
      • zip ⁠string
    • dates ⁠object

      With the following properties:

      Optional
      • created_at ⁠datetime
      • ends_at ⁠datetime
      • started_at ⁠datetime
      • subscription_ends_at ⁠datetime
      • updated_at ⁠datetime
    • id ⁠string
      UUID
    • package ⁠object

      With the following properties:

      • href ⁠string
      • max_domains ⁠integer
      • name ⁠string
      • name_label ⁠string
      • type ⁠string
      • type_label ⁠string
      • wildcard ⁠boolean
    • software ⁠integer
    • status ⁠string

      One of: "pending", "valid", "revoked", "replaced", "replaced_rev", "expired"

    Optional
    • assumed_name ⁠string
    • business_category ⁠string
    • card_pay_trustlogo ⁠boolean
    • cert ⁠string
    • csr ⁠string
    • dcv_method ⁠string

      One of: "email", "dns", "file", "http", "https"

      The certificate validation method
    • error_msg ⁠string
    • href ⁠string
    • ida ⁠object

      With the following properties:

      Optional
      • email ⁠string
      • fax ⁠string
      • tel ⁠string
    • intermediate ⁠string
    • joi ⁠object

      With the following properties:

      Optional
      • country ⁠string
      • locality ⁠string
      • state ⁠string
    • middleman ⁠object

      With the following properties:

      Optional
      • city ⁠string
      • country ⁠string
      • email ⁠string
      • family ⁠string
      • given ⁠string
      • orgname ⁠string
      • state ⁠string
      • streetaddr ⁠string
      • zip ⁠string
    • owner ⁠string
    • reissuable ⁠boolean
    • renewable ⁠boolean
    • sha_version ⁠integer
    • sharing_id ⁠string
    • state ⁠string
    • state_detail ⁠string
    • stored ⁠boolean
    • trustlogo ⁠boolean
    • trustlogo_token ⁠object

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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

post Renew a certificate

This route renews an existing certificate.

Request

URI Parameters
    • id ⁠string
      Certificate ID
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 Apikey, followed by the user's API Key.
      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:

    Optional
    • csr ⁠string
    • dcv_method ⁠string
    • duration ⁠integer

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
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.

202

The request has been accepted.
Headers
  • Optional
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

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

    • 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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

patch Update a certificate

This route updates an existing certificate.

Request

URI Parameters
    • id ⁠string
      Certificate ID
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 Apikey, followed by the user's API Key.
      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:

    Optional
    • altnames ⁠array[ string ]
    • csr ⁠string
    • dcv_method ⁠string

Responses

200

Dry-Run response. You will get this response when you send your request. with a Dry-Run: 1 header.
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.

202

The request has been accepted.
Headers
  • Optional
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

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

    • 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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

delete Revoke a certificate

This route revokes an existing certificate.

Request

URI Parameters
    • id ⁠string
      Certificate ID
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 Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

204

Certificate will be revoked.

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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Retrieve certificate

https://api.gandi.net/v5/certificate/issued-certs/{id}/crt

get Retrieve certificate

This route retrieves the certificate in text format.

Request

URI Parameters
    • id ⁠string
      Certificate ID
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

Body
  • text/plain
    ⁠string
    the certificate

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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Certificate validation

https://api.gandi.net/v5/certificate/issued-certs/{id}/dcv

put Resend the DCV

This route asks the provider to resend the DCV for that operation.

Request

URI Parameters
    • id ⁠string
      Certificate ID
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 Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

202

The request has been accepted.
Headers
  • Optional
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

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

    • 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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

patch Update the DCV method

This route asks the provider to change the DCV method for that operation.

Request

URI Parameters
    • id ⁠string
      Certificate ID
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 Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
Body
  • application/json
    ⁠object

    With the following properties:

    Required
    • method ⁠string

      One of: "email", "dns", "file", "http", "https"

Responses

201

The resource has been created.
Headers
  • Optional
    • Location ⁠string
Body
  • application/json
    ⁠object

    With the following properties:

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

    • 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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

DCV parameters

https://api.gandi.net/v5/certificate/issued-certs/{id}/dcv_params

post Retrieve DCV parameters

Get parameters for DCV (Domain Control Validation). DCV is a security check that validates/grants access to the registred domain name.

Despite being a post method, this route does not perform any change on your existing certificates.

If you want to perform a DCV through DNS, pass the parameter dvc_method with dns.

Request

URI Parameters
    • id ⁠string
      Certificate ID
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
Body
  • application/json
    ⁠object

    With the following properties:

    Optional
    • csr ⁠string
      Certificate Signing Request
    • dcv_method ⁠string

      One of: "email", "dns", "file", "http", "https"

      The certificate validation method
    • package ⁠string
      Certificate package name as returned in the package list route.

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • dcv_method ⁠string

      One of: "email", "dns", "file", "http", "https"

      The certificate validation method
    • fqdns ⁠array[ string ]
    • md5 ⁠string
    • sha256 ⁠string
    Optional
    • messages ⁠array[ string ]
    • raw_messages ⁠array[ array[ string ] ]
    • unique_value ⁠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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Certificate Packages

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

get Package list

This route returns a list of all available certificate packages.

Request

Query String
  • Optional
    • category ⁠string
    • max_domains ⁠integer
    • min_domains ⁠integer
    • 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.
    • trustlogo ⁠boolean
    • warranty ⁠integer
    • wildcard ⁠boolean
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

Headers
    • Total-Count ⁠integer
      Total number of items.
    Optional
    • Link ⁠string
      Links to next and last page.
Body
  • application/json
    ⁠array

    Of items of type:

    • object

      With the following properties:

      • category ⁠object

        With the following properties:

        • name ⁠string
      • href ⁠string
      • max_domains ⁠integer
      • min_domains ⁠integer
      • name ⁠string
      • sgc ⁠boolean
      • trustlogo ⁠boolean
      • warranty ⁠integer
      • wildcard ⁠boolean

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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Package information

https://api.gandi.net/v5/certificate/packages/{name}

get Package information

This route returns the information about a certificate package

Request

URI Parameters
    • name ⁠string
      Package name

Responses

200

Body
  • application/json
    ⁠object

    With the following properties:

    • category ⁠object

      With the following properties:

      • name ⁠string
    • href ⁠string
    • max_domains ⁠integer
    • min_domains ⁠integer
    • name ⁠string
    • sgc ⁠boolean
    • trustlogo ⁠boolean
    • warranty ⁠integer
    • wildcard ⁠boolean

Intermediate certificate

https://api.gandi.net/v5/certificate/pem/{type}

get Intermediate certificate

This route returns an intermediate certificate in a text/plain response. It must be used to generate the full chain certificate.

Request

URI Parameters
    • type ⁠string

      One of: "cert_std", "cert_free", "cert_bus", "cert_pro"

      Certificate type
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

Body
  • text/plain
    ⁠string
    Plain text intermediate certificate.

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

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorization ⁠string
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Last modification: Jun. 16th 2022