API v2: GET Request > url field - does not include port #956

New Issue

adam · 2025-12-29T16:27:15+01:00

adam commented

2025-12-29 16:27:15 +01:00

Originally created by @troxil on GitHub (May 16, 2017).

Issue type: Bug

Python version: 2.7.6
NetBox version: 2.0.2

When using API with GET requests, responds with a url field that has a absolute path is including host, but no port.

Suggestion would be respond with relative path instead of absolutes.

E.G GET http://ipam.fqdn.internal:8081/api/dcim/devices/9
Response:

{
  "id": 9,
  "name": "Some Device",
  "display_name": "Some Device",
  "device_type": {
    "id": 9,
    "url": "http://ipam.fqdn.internal/api/dcim/device-types/9/",
    "manufacturer": {
      "id": 6,
      "url": "http://ipam.fqdn.internal/api/dcim/manufacturers/6/",
      "name": "Device",
      "slug": "device"
    },
    "model": "MODEL",
    "slug": "SLUG"
  },
... }

configuration.py

# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
ALLOWED_HOSTS = ['ipam.fqdn.internal','192.168.1.10', 'ipam.fqdn.internal:8081']

Originally created by @troxil on GitHub (May 16, 2017).  ### Issue type: Bug  **Python version: 2.7.6** **NetBox version: 2.0.2**  When using API with GET requests, responds with a url field that has a absolute path is including host, but no port. Suggestion would be respond with relative path instead of absolutes. E.G GET http://ipam.fqdn.internal:8081/api/dcim/devices/9 Response: ```json { "id": 9, "name": "Some Device", "display_name": "Some Device", "device_type": { "id": 9, "url": "http://ipam.fqdn.internal/api/dcim/device-types/9/", "manufacturer": { "id": 6, "url": "http://ipam.fqdn.internal/api/dcim/manufacturers/6/", "name": "Device", "slug": "device" }, "model": "MODEL", "slug": "SLUG" }, ... } ``` configuration.py ```python # Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local'] ALLOWED_HOSTS = ['ipam.fqdn.internal','192.168.1.10', 'ipam.fqdn.internal:8081'] ```

adam closed this issue

2025-12-29 16:27:15 +01:00

adam commented

2025-12-29 16:27:15 +01:00

@jeremystretch commented on GitHub (May 16, 2017):

The URLs for serialized objects are formed using Django REST Framework's HyperlinkedIdentityField, which determines the host for the URL based on the incoming request. It looks like your httpd isn't forwarding information about the port it's running on to the WSGI service behind it.

If you're using nginx, try adding the following to your location / block:

proxy_set_header Host $host:8081;

We want to ensure we always return absolute URLs from the API to minimize the burden on the client.

@jeremystretch commented on GitHub (May 16, 2017): The URLs for serialized objects are formed using Django REST Framework's [HyperlinkedIdentityField](http://www.django-rest-framework.org/api-guide/relations/#hyperlinkedidentityfield), which determines the host for the URL based on the incoming request. It looks like your httpd isn't forwarding information about the port it's running on to the WSGI service behind it. If you're using nginx, try adding the following to your `location /` block: ``` proxy_set_header Host $host:8081; ``` We want to ensure we always return absolute URLs from the API to minimize the burden on the client.

adam commented

2025-12-29 16:27:15 +01:00

@jeremystretch commented on GitHub (May 24, 2017):

Closing due to lack of activity.

@jeremystretch commented on GitHub (May 24, 2017): Closing due to lack of activity.

adam referenced this issue

2025-12-29 22:19:52 +01:00

[PR #966] [MERGED] Release v1.9.2 #12144

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#956