Docs
Management API
Site Certificate

Site Certificate

Get a Site’s SSL/TLS Certificate Information

GET /sites/{site_id}/certificate

Request

Obtain information about a site’s SSL/TLS certificate.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • site_id in path - integer
    required

example

Response

OK

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Upsert a Site’s SSL/TLS Certificate Information

PUT /sites/{site_id}/certificate

Request

  • If a value for url is not supplied, the saved certificate is associated with the specified site’s primary URL.
  • Use caution. Because this endpoint upserts, supplying an SSL certificate for a domain that already has a certificate connected overwrites the domain’s extant certificate.'

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • site_id in path - integer
    required
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • url
    string

    URL for the site.

    Example: kittens.mybigcommerce.com

  • certificate
    object

example

Response

OK

Body

object | application/json
  • data
    object

  • meta
    object

example

Get Site Certificates

GET /sites/certificates

Request

Return all SSL certificates connected to domains within a store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • urls:in in query - array

    A comma-separated list that filters certificates by one or more URLs.

    Type: array[string]

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?