REST API
Available inCommunityCloudEnterprise
The plugin exposes a REST API under /api/plugins/changes/. All endpoints follow standard NetBox REST API conventions for filtering, pagination, and authentication.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET, POST | /api/plugins/changes/change-requests/ | List or create change requests |
| GET, PUT, PATCH, DELETE | /api/plugins/changes/change-requests/{id}/ | Retrieve, update, or delete a change request |
| GET, POST | /api/plugins/changes/comments/ | List or create comments |
| GET, PUT, PATCH, DELETE | /api/plugins/changes/comments/{id}/ | Retrieve, update, or delete a comment |
| GET, POST | /api/plugins/changes/comment-replies/ | List or create comment replies |
| GET, PUT, PATCH, DELETE | /api/plugins/changes/comment-replies/{id}/ | Retrieve, update, or delete a comment reply |
| GET, POST | /api/plugins/changes/policies/ | List or create policies |
| GET, PUT, PATCH, DELETE | /api/plugins/changes/policies/{id}/ | Retrieve, update, or delete a policy |
| GET, POST | /api/plugins/changes/policy-rules/ | List or create policy rules |
| GET, PUT, PATCH, DELETE | /api/plugins/changes/policy-rules/{id}/ | Retrieve, update, or delete a policy rule |
| GET, POST | /api/plugins/changes/reviews/ | List or create reviews |
| GET, PUT, PATCH, DELETE | /api/plugins/changes/reviews/{id}/ | Retrieve, update, or delete a review |
Additional Actions
Retrigger Events
POST /api/plugins/changes/change-requests/{id}/retrigger/
Re-emits all event rules for the specified change request. This is useful when an external system (such as a webhook target) missed or failed to process the original event. Requires change permission on the change request.
Computed Fields
The API includes the following computed fields in responses:
- Policy:
rule_count(integer) -- the number of rules associated with the policy. - Change Request:
comment_count(integer) -- the number of comments on the change request.