Read the certificate details

GET

/api/v1/tls

const url = 'http://pwrman.local/api/v1/tls';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://pwrman.local/api/v1/tls

Authorizations

None
token

Responses

200

Whether HTTPS is on, and the installed certificate.

application/json

object

enabled

required

The https setting.

boolean

active

required

HTTPS is serving, and port 80 redirects to it.

boolean

installed

required

A certificate is installed. The fields below appear only then.

boolean

names

The names on the certificate.

Array<string>

issuer

string

expires

string format: date

days_left

Days until it expires; null while the controller does not know the time.

integer | null

sha256

The certificate’s SHA-256 fingerprint.

string

Example

{
  "enabled": true,
  "active": true,
  "installed": true,
  "names": [
    "pwrman.example.com"
  ],
  "issuer": "Let's Encrypt E6",
  "expires": "2026-12-30",
  "days_left": 83,
  "sha256": "3F:9A:...:C1"
}

401

Auth_read is on and the token is missing or wrong.

application/json

object

error

required

Why the request was refused, in words.

string

Example

{
  "error": "bearer token required"
}

USB Type-C® and USB-C® are registered trademarks of USB Implementers Forum.