Skip to content

Update allowed item

PATCH/settings/allowed-items/{allowedItemId}

Endpoint API · Allowed Items

Update an allowed item.

Required permissionendpoint-state:update

Parameters

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

Request body

Content type: application/json

Request body fields

commentstring
Comment indicating why the item should be allowed.

Request samples

curl -X PATCH "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/allowed-items/<allowedItemId>" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>" -H "Content-Type: application/json" -d "{
  \"comment\": \"Allow the patch request for Updating.\"
}"


import requests

response = requests.patch(
    "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/allowed-items/<allowedItemId>",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
        "Content-Type": "application/json",
    },
    json={'comment': 'Allow the patch request for Updating.'},
)
print(response.json())


$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
    "Content-Type" = "application/json"
}
$body = '{
  "comment": "Allow the patch request for Updating."
}'
Invoke-RestMethod -Method PATCH -Uri "https://api-<data-region>.central.sophos.com/endpoint/v1/settings/allowed-items/<allowedItemId>" -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/allowed-items/<allowedItemId>", strings.NewReader(`{
  "comment": "Allow the patch request for Updating."
}`))
    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/allowed-items/<allowedItemId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "comment": "Allow the patch request for Updating."
}),
});
const data = await response.json();
console.log(data);

Responses

200 — Updated allowed item.

Response fields

idstring (uuid)required
Unique ID for the allowed application.
createdAtstring (date-time)required
Date and time (UTC) when the allowed application was created.
updatedAtstring (date-time)
Date and time (UTC) when the allowed application was updated.
propertiesobjectrequired
Allowed item properties.
Show child attributesHide child attributes
fileNamestring
File name.
pathstring
Path for the application.
sha256string
Sha256 value for the application.
certificateSignerstring
Value saved for the certificateSigner.
commentstringrequired
Comment indicating why the item was allowed.
typestringrequired
Property by which an item is allowed.
Must be one of: path, sha256, certificateSigner, posixPath.
createdByobject
User.
Show child attributesHide child attributes
idstring (uuid)required
Unique ID for the user.
namestring
Person's name.
originPersonobject
User.
Show child attributesHide child attributes
idstring (uuid)required
Unique ID for the user.
namestring
Person's name.
originEndpointobject
Represents a referenced object.
Show child attributesHide child attributes
idstring (uuid)required
The ID of the referenced object.

Errors

Status Meaning
404 Can't find allowed item.
500 Unexpected error.

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

Response examples

200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2019-09-23T12:02:01.700Z",
  "updatedAt": "2019-09-23T12:02:01.700Z",
  "properties": {
    "fileName": "string",
    "path": "string",
    "sha256": "string",
    "certificateSigner": "string"
  },
  "comment": "string",
  "type": "path",
  "createdBy": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "originPerson": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "originEndpoint": {
    "id": "00000000-0000-0000-0000-000000000000"
  }
}

See the guide for a narrative walkthrough of this API.