---
title: "Get the mTLS settings"
canonical: "https://bird.com/docs/api/reference/get-workspace-mtls-settings"
---

# Get the mTLS settings

`GET /v1/workspace/mtls-settings`

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

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.
- `https://platform.bird.com`: Region-independent endpoint for authentication and account administration.
- `http://localhost:8080`: Local development.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

- `CookieAuth`: Send `bird_session` in cookie. Session cookie set after signing in to the Bird dashboard. The cookie
value is an opaque session token; no session data is stored in the cookie
itself.

## Code samples

**cURL**

```sh
curl -X GET "https://us1.platform.bird.com/v1/workspace/mtls-settings" \
  -H "Authorization: Bearer $TOKEN"
```

Examples: [cURL](/docs/api/reference/get-workspace-mtls-settings.curl.md)

## Example response `200`

```json
{
  "state": "disabled",
  "expected_san": "spiffe://example.com/billing",
  "crl_check": "disabled"
}
```

## Header parameters

- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Response body

- `state` (string, required)

  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, required): 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, required)

  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`

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)