Sign inGet Started

Get the mTLS settings

GET
/v1/workspace/mtls-settings
curl -X GET "https://us1.platform.bird.com/v1/workspace/mtls-settings" \
  -H "Authorization: Bearer $TOKEN"
Respons200
{
  "state": "disabled",
  "expected_san": "spiffe://example.com/billing",
  "crl_check": "disabled"
}

Returns the client certificate (mTLS) settings for API requests to your workspace.

Payload Respons

state
string
wajib

Whether client certificates are off (disabled), checked while the previous behavior stays available (evaluating), or required (enforced).

Possible values: disabled, evaluating, enforced

expected_san
nullable string
wajib

A subject alternative name that every client certificate must contain, as a DNS name or a URI. null when any subject alternative name is accepted.

crl_check
string
wajib

How a certificate chain is checked against the certificate revocation list (CRL) that each certificate names. With full_chain, the leaf certificate and each intermediate certificate below the trusted root are checked. A certificate that names no CRL is not checked.

Possible values: disabled, full_chain