Unable to Run Reports via Calls to API #2227

New Issue

adam · 2025-12-29T17:23:56+01:00

adam commented

2025-12-29 17:23:56 +01:00

Originally created by @bdlamprecht on GitHub (Dec 19, 2018).

Environment

Python version: 3.6.5
NetBox version: 2.5.1

Steps to Reproduce

Create a sample report such as the documented (pending update to use v2.5 variables) example.

Attempt to get the reports from the API using the following code:

$ curl -X GET "http://netbox.local/api/extras/reports/" -H "accept: application/json; indent=2"

This results in the following output:

[
  {
    "module": "devices",
    "name": "DeviceConnectionsReport",
    "description": "Validate the minimum physical connections for each device",
    "test_methods": [
      "test_console_connection",
      "test_power_connections"
    ],
    "result": {
      "url": "http://netbox.local/api/extras/reports/devices.DeviceConnectionsReport/",
      "created": "2018-12-19T22:09:30.534847Z",
      "user": null,
      "failed": true
    }
  }
]

There is no id assigned to this report (or other future reports which may be created).

When attempting to run the report using the API, the only call I can locate (using swagger) is:

/api/extras/reports/{id}/run/

Guessing at using the id=1 doesn't work and the results is as follows:

curl -X POST "http://netbox.local/api/extras/reports/1/run/" -H "accept: application/json; indent=2" -H "Authorization: Token $NB_TOKEN"
{
  "detail": "Not found."
}

Expected Behavior

An id should be associated with each report to then be able to run it via the API.
The report to actually run correctly similar to being executed in the WebUI.

Observed Behavior

Explained above.

Originally created by @bdlamprecht on GitHub (Dec 19, 2018). ### Environment * Python version: 3.6.5 * NetBox version: 2.5.1 ### Steps to Reproduce Create a sample report such as the [documented](https://netbox.readthedocs.io/en/stable/additional-features/reports/#writing-reports) (pending update to use `v2.5` variables) example. Attempt to get the reports from the API using the following code: ``` $ curl -X GET "http://netbox.local/api/extras/reports/" -H "accept: application/json; indent=2" ``` This results in the following output: ``` [ { "module": "devices", "name": "DeviceConnectionsReport", "description": "Validate the minimum physical connections for each device", "test_methods": [ "test_console_connection", "test_power_connections" ], "result": { "url": "http://netbox.local/api/extras/reports/devices.DeviceConnectionsReport/", "created": "2018-12-19T22:09:30.534847Z", "user": null, "failed": true } } ] ``` There is no `id` assigned to this `report` (or other future `reports` which may be created). When attempting to run the report using the API, the only call I can locate (using `swagger`) is: ``` /api/extras/reports/{id}/run/ ``` Guessing at using the `id=1` doesn't work and the results is as follows: ``` curl -X POST "http://netbox.local/api/extras/reports/1/run/" -H "accept: application/json; indent=2" -H "Authorization: Token $NB_TOKEN" { "detail": "Not found." } ``` ### Expected Behavior 1. An `id` should be associated with each report to then be able to run it via the API. 2. The report to actually run correctly similar to being executed in the WebUI. ### Observed Behavior Explained above.

adam closed this issue

2025-12-29 17:23:57 +01:00

adam commented

2025-12-29 17:23:57 +01:00

@jeremystretch commented on GitHub (Dec 21, 2018):

Reports do not have numeric keys as they are not database objects. To reference an individual report, access it as <module>.<name>. In your example, this would be /api/extras/reports/devices.DeviceConnectionsReport/.

@jeremystretch commented on GitHub (Dec 21, 2018): Reports do not have numeric keys as they are not database objects. To reference an individual report, access it as `<module>.<name>`. In your example, this would be `/api/extras/reports/devices.DeviceConnectionsReport/`.

adam commented

2025-12-29 17:23:57 +01:00

@bdlamprecht commented on GitHub (Dec 21, 2018):

I guess this has something to do with the issues to date with the Swagger API browser mentioned in #2705 as id is the only format is currently allows.

@bdlamprecht commented on GitHub (Dec 21, 2018): I guess this has something to do with the issues to date with the Swagger API browser mentioned in #2705 as `id` is the only format is currently allows.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#2227