Certificate API

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.

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

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

Query String

• Optional

  • 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

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

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

Query String

• Optional

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

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with 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

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

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

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

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

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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • href ⁠string
  • id ⁠string
    Certificate ID
  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

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:

  • 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

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

URI Parameters

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

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

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

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

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

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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

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

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

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

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

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

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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

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:

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

Body

• application/json

  ⁠object

  With the following properties:

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

URI Parameters

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

• text/plain

  ⁠string
  the certificate

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

URI Parameters

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

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

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"

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

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

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

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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

URI Parameters

• • name ⁠string
    Package name

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

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

Body

• text/plain

  ⁠string
  Plain text intermediate certificate.

Body

• application/json

  ⁠object

  With the following properties:

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

Body

• application/json

  ⁠object

  With the following properties:

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