Skip to content

Get settings

GET/policies/{policyType}/base/settings

Endpoint API · Policy Management

Get settings of the base policy for a policy type.

Required permissionendpoint-policy:read

Parameters

Name In Type Required Description
X-Tenant-ID header string (uuid) Yes Tenant ID.
policyType path string Yes Policy type.
Must be one of: threat-protection, peripheral-control, application-control, data-collection-and-investigation, device-encryption, web-control, agent-updating, windows-firewall, endpoint-dns-protection, server-threat-protection, server-peripheral-control, server-application-control, server-web-control, server-lockdown, server-agent-updating, server-windows-firewall, server-file-integrity-monitoring, server-linux-runtime-detection, server-data-collection-and-investigation.

Request samples

curl -X GET "https://api-<data-region>.central.sophos.com/endpoint/v1/policies/threat-protection/base/settings" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>"


import requests

response = requests.get(
    "https://api-<data-region>.central.sophos.com/endpoint/v1/policies/threat-protection/base/settings",
    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/endpoint/v1/policies/threat-protection/base/settings" -Headers $headers


package main

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

func main() {
    req, err := http.NewRequest("GET", "https://api-<data-region>.central.sophos.com/endpoint/v1/policies/threat-protection/base/settings", 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/endpoint/v1/policies/threat-protection/base/settings", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses

200 — Settings of a base policy.

Errors

Status Meaning
500 Unexpected error.

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

Response examples

200

{
  "endpoint.malware.enabled": {
    "value": true,
    "recommendedValue": true,
    "sophosManaged": true
  },
  "endpoint.scans.scheduled.days": {
    "format": "string",
    "value": [
      "monday",
      "wednesday",
      "friday"
    ]
  },
  "endpoint.scans.scheduled.hour": {
    "value": "21:00"
  },
  "endpoint.scans.scheduled.start-from": {
    "value": "2020-05-13T21:00:01.000Z",
    "format": "date-time"
  },
  "endpoint.disk-encryption.key-expiration": {
    "value": 24,
    "unit": "hours",
    "recommendedValue": 48
  }
}

See the guide for a narrative walkthrough of this API.