Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DLP
Sensitivity Groups

Update the attributes of a single sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.update(stringsensitivityGroupId, SensitivityGroupUpdateParams { account_id, description, levels, name } params, RequestOptionsoptions?): SensitivityGroupUpdateResponse { id, created_at, levels, 4 more }
PUT/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}

Update the attributes of a single sensitivity group.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Zero Trust Write
ParametersExpand Collapse
sensitivityGroupId: string
formatuuid
params: SensitivityGroupUpdateParams { account_id, description, levels, name }
account_id: string

Path param

description?: string | null

Body param

levels?: Array<Level> | null

Body param: The desired final state of levels.

  • None (omitted): no level changes.
  • Some([]): delete all levels.
  • Some([...]): desired final set + order.
id?: string | null

If None (omitted), a new level will be created. Otherwise, an existing level will be updated.

formatuuid
description?: string | null
name?: string | null
name?: string | null

Body param

ReturnsExpand Collapse
SensitivityGroupUpdateResponse { id, created_at, levels, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
levels: Array<Level>
id: string
formatuuid
created_at: string
formatdate-time
name: string
updated_at: string
formatdate-time
description?: string | null
name: string
updated_at: string
formatdate-time
description?: string | null
template_id?: string | null
formatuuid

Update the attributes of a single sensitivity group.

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const sensitivityGroup = await client.zeroTrust.dlp.sensitivityGroups.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { account_id: 'account_id' },
);

console.log(sensitivityGroup.id);
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "levels": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "created_at": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "updated_at": "2019-12-27T18:11:19.117Z",
        "description": "description"
      }
    ],
    "name": "name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "template_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "levels": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "created_at": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "updated_at": "2019-12-27T18:11:19.117Z",
        "description": "description"
      }
    ],
    "name": "name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "template_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}