Sites
Get a Site’s SSL/TLS Certificate Information
GET /stores/{store_hash}/v3/sites/{site_id}/certificate
Request
Obtain information about a site’s SSL/TLS certificate.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- site_id in path - integerrequired
example
Response
OK
Body
object | application/json
dataobject
metaobject
Response metadata.
Upsert a Site’s SSL/TLS Certificate Information
PUT /stores/{store_hash}/v3/sites/{site_id}/certificate
Request
- If a value for
urlis not supplied, the saved certificate is associated with the specified site’sprimaryURL. - 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 headerrequired
Parameters
- store_hash in path - string
- site_id in path - integerrequired
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
object | application/json
urlstring
URL for the site.
Example: kittens.mybigcommerce.com
certificateobject
example
Response
OK
Body
object | application/json
dataobject
metaobject
example
Get Site Certificates
GET /stores/{store_hash}/v3/sites/certificates
Request
Return all SSL certificates connected to domains within a store.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- urls:in in query - array
A comma-separated list that filters certificates by one or more URLs.
example
Response
OK
Body
object | application/json
dataarray[object]
metaobject
Response metadata.
example
Did you find what you were looking for?