Skip to content

Policies API

Endpoints for managing patch policies.

List Policies

http
GET /api/v1/policies/
Authorization: Bearer YOUR_TOKEN

Response

json
{
  "items": [
    {
      "id": "policy-uuid",
      "name": "Windows Security Updates",
      "description": "Weekly security patches",
      "enabled": true,
      "schedule": "0 2 * * SUN",
      "target_type": "tag",
      "target_ids": ["tag-uuid"],
      "approval_required": true,
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 10
}

Create Policy

http
POST /api/v1/policies/
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "name": "Linux Security Updates",
  "description": "Monthly security patches",
  "enabled": true,
  "schedule": "0 3 1 * *",
  "target_type": "folder",
  "target_ids": ["folder-uuid"],
  "approval_required": false,
  "reboot_policy": "if_required"
}

Update Policy

http
PUT /api/v1/policies/{id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "enabled": false
}

Delete Policy

http
DELETE /api/v1/policies/{id}
Authorization: Bearer YOUR_TOKEN

Execute Policy

Run a policy immediately.

http
POST /api/v1/policies/{id}/execute
Authorization: Bearer YOUR_TOKEN

List Executions

http
GET /api/v1/policies/executions/list
Authorization: Bearer YOUR_TOKEN

Approve Patches

http
POST /api/v1/policies/approvals/{id}/approve
Authorization: Bearer YOUR_TOKEN

Released under the MIT License.