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
    • Authorizationstring
      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
    • altnamesarray[ string ]
      Alt Name list, when the certificate package permits it
    • csrstring
      Certificate Signing Request
    • dcv_methodstring

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

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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • dcv_methodstring

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

      The certificate validation method
    • fqdnsarray[ string ]
    • md5string
    • sha256string
    Optional
    • messagesarray[ string ]
    • raw_messagesarray[ array[ string ] ]
    • unique_valuestring

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • cnstring
      Filters the list by CN name, with optional patterns.
      Example: example.net
      Example: example*
      Example: *example.com
    • covered_cnstring
      Filters the list by certificates valid for a given CN.
    • packagestring
      Name of the certificate package.
    • pageinteger

      Default: 1

      Minimum: 1

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

      Minimum: 1

      How many items to display per page.
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
    • sort_bystring
    • statusstring

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

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

Responses

200

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

    Of items of type:

    • object

      With the following properties:

      • altnamesarray[ string ]
        Alt Name list, when the certificate package permits it
      • altnames_unicodearray[ string ]
        Alt Name list, when the certificate package permits it
      • cnstring

        Maximum length: 64

        Common Name
      • cn_unicodestring

        Maximum length: 64

        Common Name
      • contactobject

        With the following properties:

        Optional
        • citystring
        • countrystring
        • emailstring
        • familystring
        • givenstring
        • orgnamestring
        • statestring
        • streetaddrstring
        • zipstring
      • datesobject

        With the following properties:

        Optional
        • created_atdatetime
        • ends_atdatetime
        • started_atdatetime
        • subscription_ends_atdatetime
        • updated_atdatetime
      • idstring
        UUID
      • packageobject

        With the following properties:

        • hrefstring
        • max_domainsinteger
        • namestring
        • name_labelstring
        • typestring
        • type_labelstring
        • wildcardboolean
      • softwareinteger
      • statusstring

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

      Optional
      • assumed_namestring
      • business_categorystring
      • card_pay_trustlogoboolean
      • certstring
      • csrstring
      • dcv_methodstring

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

        The certificate validation method
      • error_msgstring
      • hrefstring
      • idaobject

        With the following properties:

        Optional
        • emailstring
        • faxstring
        • telstring
      • intermediatestring
      • joiobject

        With the following properties:

        Optional
        • countrystring
        • localitystring
        • statestring
      • middlemanobject

        With the following properties:

        Optional
        • citystring
        • countrystring
        • emailstring
        • familystring
        • givenstring
        • orgnamestring
        • statestring
        • streetaddrstring
        • zipstring
      • ownerstring
      • reissuableboolean
      • renewableboolean
      • sha_versioninteger
      • sharing_idstring
      • statestring
      • state_detailstring
      • storedboolean
      • trustlogoboolean
      • trustlogo_tokenobject

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
    Optional
    • Dry-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Required
    • packagestring
      Certificate package name as returned in the package list route.
    Optional
    • altnamesarray[ string ]
      Alt Name list, when the certificate package permits it
    • cnstring

      Maximum length: 64

      Common Name
    • csrstring
      Certificate Signing Request
    • dcv_methodstring

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

      The certificate validation method
    • durationinteger

      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
    • Warningstring
      Warning message
Body
  • application/json
    object

    With the following properties:

    • statusstring

      One of: "success", "error"

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

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

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

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

202

Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • hrefstring
    • idstring
      Certificate ID
    • messagestring
      Confirmation message.

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Headers
  • Required
    • Authorizationstring
      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:

    • altnamesarray[ string ]
      Alt Name list, when the certificate package permits it
    • altnames_unicodearray[ string ]
      Alt Name list, when the certificate package permits it
    • cnstring

      Maximum length: 64

      Common Name
    • cn_unicodestring

      Maximum length: 64

      Common Name
    • contactobject

      With the following properties:

      Optional
      • citystring
      • countrystring
      • emailstring
      • familystring
      • givenstring
      • orgnamestring
      • statestring
      • streetaddrstring
      • zipstring
    • datesobject

      With the following properties:

      Optional
      • created_atdatetime
      • ends_atdatetime
      • started_atdatetime
      • subscription_ends_atdatetime
      • updated_atdatetime
    • idstring
      UUID
    • packageobject

      With the following properties:

      • hrefstring
      • max_domainsinteger
      • namestring
      • name_labelstring
      • typestring
      • type_labelstring
      • wildcardboolean
    • softwareinteger
    • statusstring

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

    Optional
    • assumed_namestring
    • business_categorystring
    • card_pay_trustlogoboolean
    • certstring
    • csrstring
    • dcv_methodstring

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

      The certificate validation method
    • error_msgstring
    • hrefstring
    • idaobject

      With the following properties:

      Optional
      • emailstring
      • faxstring
      • telstring
    • intermediatestring
    • joiobject

      With the following properties:

      Optional
      • countrystring
      • localitystring
      • statestring
    • middlemanobject

      With the following properties:

      Optional
      • citystring
      • countrystring
      • emailstring
      • familystring
      • givenstring
      • orgnamestring
      • statestring
      • streetaddrstring
      • zipstring
    • ownerstring
    • reissuableboolean
    • renewableboolean
    • sha_versioninteger
    • sharing_idstring
    • statestring
    • state_detailstring
    • storedboolean
    • trustlogoboolean
    • trustlogo_tokenobject

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
    Optional
    • Dry-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Optional
    • csrstring
    • dcv_methodstring
    • durationinteger

Responses

200

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

    With the following properties:

    • statusstring

      One of: "success", "error"

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

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

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

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

202

Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
    Optional
    • Dry-Runinteger
      If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.
Body
  • application/json
    object

    With the following properties:

    Optional
    • altnamesarray[ string ]
    • csrstring
    • dcv_methodstring

Responses

200

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

    With the following properties:

    • statusstring

      One of: "success", "error"

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

      Of items of type:

      • object

        With the following properties:

        • descriptionstring
          Error message.
        • locationstring

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

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

202

Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with 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:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Headers
  • Required
    • Authorizationstring
      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:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

202

Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Query String
  • Optional
    • sharing_idstring
      Sharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key
Body
  • application/json
    object

    With the following properties:

    Required
    • methodstring

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

Responses

201

Headers
  • Optional
    • Locationstring
Body
  • application/json
    object

    With the following properties:

    • messagestring
      Confirmation message.

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • idstring
      Certificate ID
Headers
  • Required
    • Authorizationstring
      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
    • csrstring
      Certificate Signing Request
    • dcv_methodstring

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

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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • dcv_methodstring

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

      The certificate validation method
    • fqdnsarray[ string ]
    • md5string
    • sha256string
    Optional
    • messagesarray[ string ]
    • raw_messagesarray[ array[ string ] ]
    • unique_valuestring

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • categorystring
    • max_domainsinteger
    • min_domainsinteger
    • pageinteger

      Default: 1

      Minimum: 1

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

      Minimum: 1

      How many items to display per page.
    • trustlogoboolean
    • warrantyinteger
    • wildcardboolean
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

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

    Of items of type:

    • object

      With the following properties:

      • categoryobject

        With the following properties:

        • namestring
      • hrefstring
      • max_domainsinteger
      • min_domainsinteger
      • namestring
      • sgcboolean
      • trustlogoboolean
      • warrantyinteger
      • wildcardboolean

403

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      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
    • namestring
      Package name

Responses

200

Body
  • application/json
    object

    With the following properties:

    • categoryobject

      With the following properties:

      • namestring
    • hrefstring
    • max_domainsinteger
    • min_domainsinteger
    • namestring
    • sgcboolean
    • trustlogoboolean
    • warrantyinteger
    • wildcardboolean

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
    • typestring

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

      Certificate type
Headers
  • Required
    • Authorizationstring
      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:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

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

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

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
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key