Skip to content

Get current settings

GET/settings/event-journal/{endpointType}

Endpoint API · Event Journal

Get all event journal settings.

Required permissionendpoint-state:read

Parameters

Name In Type Required Description
X-Tenant-ID header string (uuid) Yes Tenant ID.
endpointType path string (enum) Yes Endpoint type.
Must be one of: computer, server.

Request samples

curl -X GET "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/event-journal/computer" -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/settings/event-journal/computer",
    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/settings/event-journal/computer" -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/settings/event-journal/computer", 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/settings/event-journal/computer", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses

200 — Retrieved event journal settings.

Response fields

useRecommendedbooleanrequired
Shows if the recommended setting is being used.
diskSpaceLimitInMBobjectrequired
Show child attributesHide child attributes
recommendedValueintegerrequired
Maximum size of the event journal (MB).
Must be ≥ 300 and ≤ 30000.
valueinteger
Maximum size of the event journal (MB).
Must be ≥ 300 and ≤ 30000.
diskSpaceLimitAsPercentageobjectrequired
Show child attributesHide child attributes
recommendedValueintegerrequired
Disk space limit for the event journal (percentage). The value 0 will mean Disk space limit is not specified. Supported values [0, 10, 20, 30, 40].
Must be ≥ 0 and ≤ 40. Must be a multiple of 10.
valueinteger
Disk space limit for the event journal (percentage). The value 0 will mean Disk space limit is not specified. Supported values [0, 10, 20, 30, 40].
Must be ≥ 0 and ≤ 40. Must be a multiple of 10.

Errors

Status Meaning
400 Bad request.
401 Authentication required.
403 Authorization required.
404 Customer not found.
500 Unexpected error.

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

Response examples

200

{
  "useRecommended": true,
  "diskSpaceLimitInMB": {
    "recommendedValue": 5250,
    "value": 8000
  },
  "diskSpaceLimitAsPercentage": {
    "recommendedValue": 0,
    "value": 10
  }
}

See the guide for a narrative walkthrough of this API.