Docs
Management API
Sites
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

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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/sites/[site_id]/certificate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

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

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

{
"url": "kittens.mybigcommerce.com",
"certificate": {
"certificate": "string",
"private_key": "string",
"intermediate_certificates": "string"
}
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

example

{
"data": {},
"meta": {}
}

Get Site Certificates

GET /sites/certificates

Request

Return all SSL certificates connected to domains within a store.

Authentication

  • X-Auth-Token in header

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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/sites/certificates' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
"data": [
{
"common_name": "store.com",
"subject_alternative_names": [
"store.com",
"www.store.com"
],
"validity_not_before": "2018-01-04T04:15:50.000Z",
"validity_not_after": "2018-01-04T04:15:50.000Z",
"signing_algorithm": "string",
"issuer": "string",
"certificate": "string",
"intermediate_certificates": "string"
}
],
"meta": {}
}
Did you find what you were looking for?
Delete a SiteGet a Site’s SSL TLS Certificate Information