Internal CA certificate info¶

GET/smime/ca/internal

Get information about the internal CA certificate.

Parameters¶

Name	In	Type	Required	Description
`X-Tenant-ID`	header	string (uuid)	Yes	Tenant ID.

Request samples¶

cURLPythonPowerShellGoJavaScript

curl -X GET "https://api-<data-region>.central.sophos.com/email/v1/smime/ca/internal" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>"

import requests

response = requests.get(
    "https://api-<data-region>.central.sophos.com/email/v1/smime/ca/internal",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
    },
)
print(response.json())

$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
}
Invoke-RestMethod -Method GET -Uri "https://api-<data-region>.central.sophos.com/email/v1/smime/ca/internal" -Headers $headers

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, err := http.NewRequest("GET", "https://api-<data-region>.central.sophos.com/email/v1/smime/ca/internal", nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer <access-token>")
    req.Header.Set("X-Tenant-ID", "<tenant-id>")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

const response = await fetch("https://api-<data-region>.central.sophos.com/email/v1/smime/ca/internal", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses¶

`200` — Internal CA certificate information.¶

Response fields

fingerprintstringrequired

SHA-256 fingerprint of the certificate.
Must match the pattern ^[a-fA-F0-9]{64}$. Must be exactly 64 characters long.

certificateDetailsobjectrequired

Detailed information about a CA certificate.

Show child attributesHide child attributes

subjectstring

Certificate subject distinguished name.
Must be at most 255 characters long.

commonNamestring

Certificate common name (CN).
Must be at most 255 characters long.

issuerstringrequired

Certificate issuer distinguished name.
Must be at most 255 characters long.

validFromstring (date-time)required

Certificate validity start date.

expiresAtstring (date-time)required

Certificate validity end date.

originstringrequired

Indicates how the certificate was obtained.
Must be one of: created, uploaded, extracted, unknown.

Errors¶

Status	Meaning
`400`	Invalid request.
`401`	Authentication required.
`403`	Authorization required.
`404`	Resource not found.
`500`	Internal server error.
`503`	Server Unavailable.

All error responses share the same shape — see the error response object.

Response examples¶

`200`¶

{
  "fingerprint": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2",
  "certificateDetails": {
    "subject": "C=UK,O=Sophos Limited,CN=Sophos Intermediate CA - A",
    "commonName": "Sophos Intermediate CA - A",
    "issuer": "C=UK,O=Sophos Limited,CN=Sophos Root CA",
    "validFrom": "2024-12-31T14:25:09Z",
    "expiresAt": "2029-12-31T18:30:12Z",
    "origin": "created"
  }
}

See the guide for a narrative walkthrough of this API.