Skip to content

Update TLS settings

PATCH/settings/web-control/tls-decryption

Endpoint API · Web Control

Update settings for SSL/TLS decryption of HTTPS websites.

Required permissionendpoint-state:update

Parameters

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

Request body

Content type: application/json

Request body fields

categoriesarray of object
Web categories.
Must contain at most 5 items. Items must be unique.
Show child attributesHide child attributes
idintegerrequired
Web decryption category ID matching the Web Control categories.
Must be one of: 10, 14, 20, 27, 54.
decryptionEnabledbooleanrequired
Whether web decryption is enabled on websites in this category.

Request samples

curl -X PATCH "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/web-control/tls-decryption" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>" -H "Content-Type: application/json" -d "{
  \"categories\": [
    {
      \"id\": 10,
      \"decryptionEnabled\": true
    }
  ]
}"


import requests

response = requests.patch(
    "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/web-control/tls-decryption",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
        "Content-Type": "application/json",
    },
    json={'categories': [{'id': 10, 'decryptionEnabled': True}]},
)
print(response.json())


$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
    "Content-Type" = "application/json"
}
$body = '{
  "categories": [
    {
      "id": 10,
      "decryptionEnabled": true
    }
  ]
}'
Invoke-RestMethod -Method PATCH -Uri "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/web-control/tls-decryption" -Headers $headers -Body $body -ContentType "application/json"


package main

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

func main() {
    req, err := http.NewRequest("PATCH", "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/web-control/tls-decryption", strings.NewReader(`{
  "categories": [
    {
      "id": 10,
      "decryptionEnabled": true
    }
  ]
}`))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer <access-token>")
    req.Header.Set("X-Tenant-ID", "<tenant-id>")
    req.Header.Set("Content-Type", "application/json")

    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/endpoint/v1/settings/web-control/tls-decryption", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "categories": [
    {
      "id": 10,
      "decryptionEnabled": true
    }
  ]
}),
});
const data = await response.json();
console.log(data);

Responses

200 — Updated web decryption settings.

Response fields

categoriesarray of object
Web categories.
Items must be unique.
Web category for SSL/TLS decryption of HTTPS websites.
Show child attributesHide child attributes
idinteger
Web decryption category ID matching the Web Control categories.
Must be one of: 10, 14, 20, 27, 54.
namestring
Mnemonic name of this category.
labelstring
Human readable name of this category.
decryptionEnabledboolean
Whether web decryption is enabled on websites in this category.
excludedWebsitesobject
Show child attributesHide child attributes
itemsCountinteger
Must be ≥ 0 and ≤ 500.
totalinteger
Must be ≥ 0 and ≤ 500.
itemsarray of object
Websites excluded from decryption.
Must contain at most 500 items.
A website IP, range of IPs or domain to be excluded from SSL/TLS decryption of HTTPS websites.
Show child attributesHide child attributes
valuestring
Website IP address, IP address range or domain.
commentstring
Comment indicating why the site was excluded.

Errors

Status Meaning
500 Unexpected error.

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

Response examples

200

{
  "categories": [
    {
      "id": 10,
      "name": "string",
      "label": "string",
      "decryptionEnabled": true
    }
  ],
  "excludedWebsites": {
    "itemsCount": 0,
    "total": 0,
    "items": [
      {
        "value": "string",
        "comment": "string"
      }
    ]
  }
}

See the guide for a narrative walkthrough of this API.