Site Certificate
Get a Site’s SSL TLS Certificate Information
GET https://api.bigcommerce.com/stores/{store_hash}/v3/sites/{site_id}/certificateRequest
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 - stringrequiredThe MIME type of the response body.
- site_id in path - integerrequired
example
Response
OK
Body
object | application/json
dataobject
Upsert a Site’s SSL TLS Certificate Information
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/sites/{site_id}/certificateRequest
- If a value for
url
is not supplied, the saved certificate is associated with the specified site’sprimary
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 - stringrequiredThe MIME type of the response body.
- site_id in path - integerrequired
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
urlstring
URL for the site.Example: kittens.mybigcommerce.comcertificateobject
example
Response
OK
Body
object | application/json
dataobject
example
Get Site Certificates
GET https://api.bigcommerce.com/stores/{store_hash}/v3/sites/certificatesRequest
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 - stringrequiredThe MIME type of the response body.
- urls:in in query - arrayA comma-separated list that filters certificates by one or more URLs.Type: array[string]
example
Response
OK
Body
object | application/json
dataarray[object]
example
Did you find what you were looking for?