Skip to main content

Update Resource Set Policy

This API updates an existing resource set policy, including its name, description, and resources.

Endpoint Details

URL/v1/config-agent/resource-sets/id
MethodPUT
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To update an existing resource set policy, use the following request format:

/v1/config-agent/resource-sets/ed7cced2-2c8a-4779-b8e6-408f4a28a4b3

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the resource set policy to update

Request Body

Use the following format to make a request:

JSON Request
{
"name": "dummy resource sets",
"description": "add description dummy",
"resources": [
{
"directory": "/data/secure",
"file": "*",
"type_os": "Windows",
"include_sub_directory": true
}
]
}

Body Parameters

ParameterTypeDescription
nameStringUpdated name of the resource set policy
descriptionStringOptional description of the resource set policy
resourcesArrayList of resources included in the policy
directoryStringDirectory path the policy applies to
fileStringFile pattern the policy applies to
type_osStringOperating system type the resource applies to
include_sub_directoryBooleanIndicates whether subdirectories are included

Response

Here is an example response when the data is successfully updated:

Response
{
"data": {
"id": "ed7cced2-2c8a-4779-b8e6-408f4a28a4b3",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Dummy Resource Sets",
"description": "add description dummy",
"resources": [
{
"directory": "/data/secure",
"file": "*",
"type_os": "Windows",
"include_sub_directory": true
}
],
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by_name": "Admin Aplikasi",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by_name": "Admin Aplikasi",
"created_at": 1785211029,
"updated_at": 1785211402
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the resource set policy
tenant_idUUIDIdentifier of the tenant that owns the resource set policy
nameStringName of the resource set policy
descriptionStringDescription of the resource set policy
resourcesArrayList of resources included in the policy
directoryStringDirectory path the policy applies to
fileStringFile pattern the policy applies to
type_osStringOperating system type the resource applies to
include_sub_directoryBooleanIndicates whether subdirectories are included
created_byUUIDIdentifier of the user who created the policy
created_by_nameStringDisplay name of the user who created the policy
updated_byUUIDIdentifier of the user who last updated the policy
updated_by_nameStringDisplay name of the user who last updated the policy
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing resource set policy.
  • When file is set to *, the policy applies to all files in the directory.
  • When include_sub_directory is set to true, the policy also applies to files within subdirectories.
  • Supported type_os values are Windows and NonWindows.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.