Skip to content

Recommended packages

GET/software/packages/recommended

Endpoint API · Packages

Get all Sophos Recommended packages for the tenant.

Required permissionendpoint-versions:read

Parameters

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

Request samples

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

Responses

Response fields

itemsarray of objectrequired
Sophos recommended packages.
Sophos recommended package.
Show child attributesHide child attributes
idstringrequired
Sophos recommended package ID.
platformstringrequired
OS platform type.
Must be one of: windows, linux, macOS.
endpointTypestring
Endpoint type. Please note that the type securityVm is no longer used.
Must be one of: computer, server, securityVm.
modulesarray of objectrequired
Endpoint modules in this package.
Single endpoint module.
Show child attributesHide child attributes
namestringrequired
The installed endpoint module.
Must be one of: coreAgent, deviceEncryption, interceptX, mdr.
versionstringrequired
Module version.

Errors

Status Meaning
400 Bad Request.
500 Unexpected error.

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

Response examples

200

{
  "items": [
    {
      "id": "recommended-winserv",
      "platform": "windows",
      "endpointType": "computer",
      "modules": [
        {
          "name": "coreAgent",
          "version": "2022.1.0.40"
        }
      ]
    }
  ]
}

See the guide for a narrative walkthrough of this API.