add more information (change by user in ui, or by api token) to changelogs #8449

Closed
opened 2025-12-29 20:36:53 +01:00 by adam · 4 comments
Owner

Originally created by @ITJamie on GitHub (Aug 10, 2023).

NetBox version

v3.5.7

Feature type

Data model extension

Proposed functionality

when an object change is made, log the source (UI or API) and the API token id(or name) if API token was used.

Use case

when a user makes a change to an object there is no details on the source of the change.
knowing if a user made a change by the UI or by the API can be useful to figure out why a change was made

it would also be great if there were filter forms to allow filtering for "UI or API" changes or changes by specific token

Database changes

two additional fields on the ObjectChange model

  • change_source (static choice of UI or API)
  • change_token_id (id of the API token to make the change (if used))

OR

one additional json field on the ObjectChange model to store the below as dict items

  • change_source (static choice of UI or API)
  • change_token_id (id of the API token to make the change (if used))

External dependencies

No response

Originally created by @ITJamie on GitHub (Aug 10, 2023). ### NetBox version v3.5.7 ### Feature type Data model extension ### Proposed functionality when an object change is made, log the source (UI or API) and the API token id(or name) if API token was used. ### Use case when a user makes a change to an object there is no details on the source of the change. knowing if a user made a change by the UI or by the API can be useful to figure out why a change was made it would also be great if there were filter forms to allow filtering for "UI or API" changes or changes by specific token ### Database changes two additional fields on the ObjectChange model - change_source (static choice of UI or API) - change_token_id (id of the API token to make the change (if used)) OR one additional json field on the ObjectChange model to store the below as dict items - change_source (static choice of UI or API) - change_token_id (id of the API token to make the change (if used)) ### External dependencies _No response_
adam added the type: featurepending closure labels 2025-12-29 20:36:53 +01:00
adam closed this issue 2025-12-29 20:36:54 +01:00
Author
Owner

@ITJamie commented on GitHub (Aug 10, 2023):

it would also potentially be good to log the source IP too

@ITJamie commented on GitHub (Aug 10, 2023): it would also potentially be good to log the source IP too
Author
Owner

@jeremystretch commented on GitHub (Aug 28, 2023):

@ITJamie could you please provide a more reader-friendly title for this issue?

@jeremystretch commented on GitHub (Aug 28, 2023): @ITJamie could you please provide a more reader-friendly title for this issue?
Author
Owner

@github-actions[bot] commented on GitHub (Nov 30, 2023):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Nov 30, 2023): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
Author
Owner

@github-actions[bot] commented on GitHub (Dec 30, 2023):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Dec 30, 2023): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8449