CustomDomain Docs
ReferenceAPI referenceConnections

The domain's certificate, its renewal and its history

The domain's certificate, its renewal and its history: CustomDomain™ API reference in the connections group. Covers parameters, request body and responses.

GET
/connections/{id}/certificate

The HTTPS certificate the edge holds for the domain, as the edge last reported it: status, issuer, when it was issued and last renewed, when it expires and the next renewal starts, the last error while renewing keeps failing, and the certificate history (issued, renewed, failed, expiring). An apex that redirects www also gets www_certificate. Every served domain has one, so this read is not behind the Secure plan feature (the /ssl management routes are). status is not_reported until the edge reports the certificate.

A delegated agent token needs domains:read.

A widget token must be the connection's end user: a connection that names another end user than the token's end_user_ref, or names one while the token names none, answers 403 token_wrong_end_user before anything is read or changed, and a connection that names none is any token's. An API key, an app-scoped token and a delegated agent token are not limited by it.

Authorization

AuthorizationBearer <token>

Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/connections/string/certificate"
{  "connection_id": "string",  "certificate": {    "host": "string",    "status": "issued",    "issuer": "string",    "issued_at": "2019-08-24T14:15:22Z",    "renewed_at": "2019-08-24T14:15:22Z",    "not_before": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "days_left": 0,    "next_renewal_at": "2019-08-24T14:15:22Z",    "last_error": "string",    "failing_since": "2019-08-24T14:15:22Z",    "failure_count": 0,    "managed": true,    "attention": "failed",    "updated_at": "2019-08-24T14:15:22Z"  },  "www_certificate": {    "host": "string",    "status": "issued",    "issuer": "string",    "issued_at": "2019-08-24T14:15:22Z",    "renewed_at": "2019-08-24T14:15:22Z",    "not_before": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "days_left": 0,    "next_renewal_at": "2019-08-24T14:15:22Z",    "last_error": "string",    "failing_since": "2019-08-24T14:15:22Z",    "failure_count": 0,    "managed": true,    "attention": "failed",    "updated_at": "2019-08-24T14:15:22Z"  },  "renewal": {    "automatic": true,    "needs_dns_access": true,    "retry_every": "string",    "how": "string"  },  "history": [    {      "id": "string",      "application_id": "string",      "connection_id": "string",      "domain": "string",      "kind": "string",      "detail": {},      "created_at": "2019-08-24T14:15:22Z"    }  ]}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}