--- title: "Update Network Alert Policy" method: PUT path: "/network-alert-policy/{id}" tags: ["Network Alert Policy"] --- # Update Network Alert Policy `PUT /network-alert-policy/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/network-alert-policy/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing Network Alert Policy ## Path parameters - `id` string, uuid, required ## Request body - object - `data` NetworkAlertPolicyUpdateSchema, required: Update schema for NetworkAlertPolicy model. Update - `name` string: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `isEnabled` boolean: Whether this policy is active. Disable it to stop provisioning monitors for matching devices without deleting the policy. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `monitorTemplateId` string, uuid: ID of the Network Device monitor template every matching device gets a monitor cloned from. Null only after the template was deleted, which disables the policy. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `scope` object: Which devices this policy covers: site ids, device role ids and label ids. A device must match every kind that is listed (AND) and any id within a kind (OR); a kind left empty matches every device. Empty altogether means every device in the project. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] ## Response `200` Updated successfully - object - `data` NetworkAlertPolicyReadSchema: Read schema for NetworkAlertPolicy model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `isEnabled` boolean: Whether this policy is active. Disable it to stop provisioning monitors for matching devices without deleting the policy. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `monitorTemplateId` string, uuid, required: ID of the Network Device monitor template every matching device gets a monitor cloned from. Null only after the template was deleted, which disables the policy. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `scope` object: Which devices this policy covers: site ids, device role ids and label ids. A device must match every kind that is listed (AND) and any id within a kind (OR); a kind left empty matches every device. Empty altogether means every device in the project. Permissions - Create: [Project Owner, Project Admin, Create Network Alert Policy], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [Project Owner, Project Admin, Edit Network Alert Policy] - `lastSyncAt` object: When the engine last reconciled this policy's monitors against its matching devices. Managed by the engine. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] - `lastSyncError` string: Why the engine's last reconciliation of this policy failed, if it did. Cleared by the next successful pass. Managed by the engine. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] - `coveredDeviceCount` number: How many devices matched this policy's scope at the engine's last reconciliation. Managed by the engine. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] - `templateSyncedAt` object: When this policy's provisioned monitors were last re-synced from the monitor template. Managed by the engine. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Alert Policy], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)