Show site certificate | Modular DS

{
  "data": {
    "attributes": {
      "configured": true,
      "days_until_expiry": 39,
      "enabled": true,
      "issuer": {
        "c": "US",
        "cn": "R11",
        "o": "Let's Encrypt",
        "ou": null
      },
      "protocol": "TLSv1.3",
      "sans": [
        "acme-corp.com",
        "www.acme-corp.com"
      ],
      "ssl_status": "up",
      "subject": {
        "c": null,
        "cn": "acme-corp.com",
        "o": null,
        "ou": null
      },
      "valid_from": "2026-08-01 00:00:00",
      "valid_to": "2026-10-30 12:00:00"
    },
    "id": "101",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/sites/101/certificate"
    },
    "type": "site-certificates"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns the site’s SSL certificate summary as a site-certificates JSON:API resource (a computed structure wrapping the site, not a stored model): 200 with {"data": {"type": "site-certificates", "id": "<site id>", "attributes": {...}}, "jsonapi": {"version": "1.1"}}. The document id is the website’s own id; there is no separate site_id attribute.

attributes, in order: configured (boolean), enabled (boolean|null), ssl_status (up / down / unknown / null), issuer ({cn, o, c, ou}|null), subject ({cn, o, c, ou}|null), valid_from (string|null), valid_to (string|null), days_until_expiry (integer|null, negative once expired), protocol (string|null, e.g. TLSv1.3) and sans (string array|null).

Path variable site is the exact site id (e.g. 12345). A site without a certificate service answers 200 with configured: false and every other attribute null.

This endpoint accepts no query parameters at all: any key (filter, sort, page, include, fields, anything) answers 422. Sites of other organizations — and members without the certificate read permission — answer 404. A read-only token is enough. The MCP twin of this endpoint is the sites-certificate-show tool.

Returns the site's SSL certificate summary as a `site-certificates` JSON:API resource (a computed structure wrapping the site, not a stored model): `200` with `{"data": {"type": "site-certificates", "id": "<site id>", "attributes": {...}}, "jsonapi": {"version": "1.1"}}`. The document id is the website's own id; there is no separate `site_id` attribute. `attributes`, in order: `configured` (boolean), `enabled` (boolean|null), `ssl_status` (`up` / `down` / `unknown` / null), `issuer` (`{cn, o, c, ou}`|null), `subject` (`{cn, o, c, ou}`|null), `valid_from` (string|null), `valid_to` (string|null), `days_until_expiry` (integer|null, negative once expired), `protocol` (string|null, e.g. `TLSv1.3`) and `sans` (string array|null). Path variable `site` is the exact site id (e.g. `12345`). A site without a certificate service answers 200 with `configured: false` and every other attribute null. This endpoint accepts **no query parameters at all**: any key (`filter`, `sort`, `page`, `include`, `fields`, anything) answers 422. Sites of other organizations — and members without the certificate read permission — answer 404. A read-only token is enough. The MCP twin of this endpoint is the `sites-certificate-show` tool.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

sitestringRequired

Response

200 - Certificate

dataobjectOptional

jsonapiobjectOptional

Path variable site is the exact site id (e.g. 12345). A site without a certificate service answers 200 with configured: false and every other attribute null.