Unable to determine NetBox version, HTTP header 'API-Version' missing. #328

Azmodeszer · 2023-07-19T06:51:39Z

Azmodeszer
Jul 19, 2023

I see this issue has come up before, but I wasn't able to fix it with the responses I found.

Trying to do a dry run of the sync:

2023-07-19 08:37:49,018 - INFO: Starting NetBox Sync v1.5.0 (2023-07-07)
2023-07-19 08:37:49,018 - DEBUG: Using config file: /opt/netbox-sync/settings-example.ini
2023-07-19 08:37:49,018 - DEBUG: Config: common.log_level = INFO
2023-07-19 08:37:49,018 - DEBUG: Config: common.log_to_file = False
2023-07-19 08:37:49,018 - DEBUG: Config: common.log_file = log/netbox_sync.log
2023-07-19 08:37:49,018 - DEBUG: Config: netbox.api_token = dd2***
2023-07-19 08:37:49,018 - DEBUG: Config: netbox.host_fqdn = 127.0.0.1
2023-07-19 08:37:49,018 - DEBUG: Config: netbox.port = 8001
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.disable_tls = True
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.validate_tls_certs = False
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.proxy = None
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.client_cert = None
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.client_cert_key = None
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.prune_enabled = False
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.prune_delay_in_days = 30
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.ignore_unknown_source_object_pruning = False
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.default_netbox_result_limit = 200
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.timeout = 30
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.max_retry_attempts = 4
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.use_caching = True
2023-07-19 08:37:49,019 - DEBUG: Config: netbox.cache_directory_location = cache
2023-07-19 08:37:49,019 - WARNING: Log level is set to DEBUG3, Request logs will only be printed to console
2023-07-19 08:37:49,019 - DEBUG: Created new requests Session for NetBox.
2023-07-19 08:37:49,021 - DEBUG: Starting new HTTP connection (1): 127.0.0.1:8001
send: b'GET /api/ HTTP/1.1\r\nHost: 127.0.0.1:8001\r\nUser-Agent: netbox-sync/1.5.0\r\nAccept-Encoding: gzip, deflate\r\nAccept: */*\r\nConnection: keep-alive\r\nAuthorization: Token xxxxxr\nContent-Type: application/json\r\n\r\n'
reply: 'HTTP/1.1 302 Found\r\n'
header: Server: gunicorn
header: Date: Wed, 19 Jul 2023 06:37:49 GMT
header: Connection: keep-alive
header: Content-Type: text/html; charset=utf-8
header: Location: /netbox/login/?next=/api/
header: X-Content-Type-Options: nosniff
header: Referrer-Policy: same-origin
header: Cross-Origin-Opener-Policy: same-origin
header: X-Frame-Options: SAMEORIGIN
header: Content-Length: 0
header: Vary: Cookie, origin
2023-07-19 08:37:49,024 - DEBUG: http://127.0.0.1:8001 "GET /api/ HTTP/1.1" 302 0
send: b'GET /netbox/login/?next=/api/ HTTP/1.1\r\nHost: 127.0.0.1:8001\r\nUser-Agent: netbox-sync/1.5.0\r\nAccept-Encoding: gzip, deflate\r\nAccept: */*\r\nConnection: keep-alive\r\nAuthorization: Token xxxxx\r\n\r\n'
reply: 'HTTP/1.1 200 OK\r\n'
header: Server: gunicorn
header: Date: Wed, 19 Jul 2023 06:37:49 GMT
header: Connection: keep-alive
header: Content-Type: text/html; charset=utf-8
header: X-Request-ID: 52c214b7-4353-4b6d-a623-f518bab85bbb
header: Vary: HX-Request, Cookie, origin
header: X-Content-Type-Options: nosniff
header: Referrer-Policy: same-origin
header: Cross-Origin-Opener-Policy: same-origin
header: X-Frame-Options: SAMEORIGIN
header: Content-Length: 5060
header: Set-Cookie: csrftoken=Q3WrPPQyumyZ6vMae2t99NTxtV5NTPzK; expires=Wed, 17 Jul 2024 06:37:49 GMT; Max-Age=31449600; Path=/netbox; SameSite=Lax
2023-07-19 08:37:49,040 - DEBUG: http://127.0.0.1:8001 "GET /netbox/login/?next=/api/ HTTP/1.1" 200 5060
2023-07-19 08:37:49,041 - INFO: Successfully connected to NetBox '127.0.0.1'
2023-07-19 08:37:49,041 - DEBUG: Detected NetBox API version: None
ERROR: Unable to determine NetBox version, HTTP header 'API-Version' missing.

Something wrong with my settings?

OS: Debian 11
Netbox: 3.5.6

Answered by Azmodeszer

Aug 7, 2023

Never mind, I gave up and just went abandonded the subpath approach. Works nicely out of the box like that. Thanks for the assist anyway.

View full answer

bb-Ricardo · 2023-07-19T08:28:18Z

bb-Ricardo
Jul 19, 2023
Maintainer

Hi,

The settings are not the issue here. It's the configuration of gunicorn.

Usually NetBox API is reachable at something like this https://my-netbox.example.com/api. In your setup you added the sub path /netbox/ to the configuration. This turns the path to the API in something like this https://my-netbox.example.com/netbox/api.

As the plain /api path is not recognised by gunicorn the script gets redirected to /netbox/login/?next=/api/ which fails to reach the API.

I recommend to remove the sub path /netbox/ from the configuration and try again.

12 replies

Azmodeszer Aug 7, 2023
Author

I've made some progress. Now it connects to the API as well as vCenter, but then it tries to retrieve a "list of tags" and runs into an authentication error:

2023-08-07 13:17:33,111 - DEBUG: Requesting a brief list of tags from NetBox
{'_body_position': None,
 '_cookies': <RequestsCookieJar[]>,
 'body': None,
 'headers': {'User-Agent': 'netbox-sync/1.5.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '*/*', 'Connection': 'keep-alive', 'Authorization': 'Token xyz', 'Content-Type': 'application/json'},
 'hooks': {'response': []},
 'method': 'GET',
 'url': 'http://127.0.0.1:80/api/extras/tags/?brief=1&limit=500&exclude=config_context'}
send: b'GET /api/extras/tags/?brief=1&limit=500&exclude=config_context HTTP/1.1\r\nHost: 127.0.0.1\r\nUser-Agent: netbox-sync/1.5.0\r\nAccept-Encoding: gzip, deflate\r\nAccept: */*\r\nConnection: keep-alive\r\nAuthorization: Token xyz \r\nContent-Type: application/json\r\n\r\n'
reply: 'HTTP/1.1 403 Forbidden\r\n'
header: Date: Mon, 07 Aug 2023 11:17:33 GMT
header: Server: gunicorn
header: Content-Type: application/json
header: Vary: HX-Request,Cookie,origin
header: Allow: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
header: X-Request-ID: 7b9f33cf-bbdd-45ca-b120-6a1ac92e5462
header: API-Version: 3.5
header: X-Content-Type-Options: nosniff
header: Referrer-Policy: same-origin
header: Cross-Origin-Opener-Policy: same-origin
header: X-Frame-Options: SAMEORIGIN
header: Content-Length: 58
header: Keep-Alive: timeout=5, max=99
header: Connection: Keep-Alive
2023-08-07 13:17:33,125 - DEBUG: http://127.0.0.1:80 "GET /api/extras/tags/?brief=1&limit=500&exclude=config_context HTTP/1.1" 403 58
2023-08-07 13:17:33,125 - DEBUG2: Received HTTP Status 403.
2023-08-07 13:17:33,125 - DEBUG: Response Body:
{'detail': 'Authentication credentials were not provided.'}
ERROR: NetBox returned: Forbidden: Authentication credentials were not provided.

Why...? /api/ and all subpaths should be exempt from login enforcement, according to my Netbox settings.py. Frustrating.

bb-Ricardo Aug 7, 2023
Maintainer

Hi,

NetBox answered reply: 'HTTP/1.1 403 Forbidden

Did you give the user the appropriate permissions?

Azmodeszer Aug 7, 2023
Author

The token was created on a test machine via the admin user. So logically it should have all permissions that user has, no?

EDIT: Still something to do with the rewrite rule maybe. When I access /netbox/api/extras/tags/?brief=1&limit=500&exclude=config_context it works, but /api/extras/tags/?brief=1&limit=500&exclude=config_context does not (but at least it asks for authentication, it's not a 404 error).

Azmodeszer Aug 7, 2023
Author

Never mind, I gave up and just went abandonded the subpath approach. Works nicely out of the box like that. Thanks for the assist anyway.

Answer selected by bb-Ricardo

jorge-sevilla · 2024-07-16T09:59:31Z

jorge-sevilla
Jul 16, 2024

Hello, I have the same error message but I am not being able to solve it, any idea?

Trying to run:

2024-07-16 09:51:20,674 - INFO: Starting NetBox Sync v1.6.1 (2024-05-14)
2024-07-16 09:51:20,674 - DEBUG: Using config file: /opt/netbox-sync/settings.ini
2024-07-16 09:51:20,674 - DEBUG: Config: common.log_level = INFO
2024-07-16 09:51:20,674 - DEBUG: Config: common.log_to_file = False
2024-07-16 09:51:20,675 - DEBUG: Config: common.log_file = log/netbox_sync.log
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.api_token = d04***
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.host_fqdn = 192.168.10.89
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.port = 443
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.disable_tls = True
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.validate_tls_certs = False
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.proxy = None
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.client_cert = None
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.client_cert_key = None
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.prune_enabled = False
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.prune_delay_in_days = 30
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.ignore_unknown_source_object_pruning = False
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.default_netbox_result_limit = 200
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.timeout = 30
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.max_retry_attempts = 4
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.use_caching = True
2024-07-16 09:51:20,675 - DEBUG: Config: netbox.cache_directory_location = cache
2024-07-16 09:51:20,675 - WARNING: Log level is set to DEBUG3, Request logs will only be printed to console
2024-07-16 09:51:20,676 - DEBUG: Created new requests Session for NetBox.
2024-07-16 09:51:20,677 - DEBUG: Starting new HTTP connection (1): 192.168.10.89:443
send: b'GET /api/ HTTP/1.1\r\nHost: 192.168.10.89:443\r\nUser-Agent: netbox-sync/1.6.1\r\nAccept-Encoding: gzip, deflate\r\nAccept: /\r\nConnection: keep-alive\r\nAuthorization: Token xxx\r\nContent-Type: application/json\r\n\r\n'
reply: 'HTTP/1.1 400 Bad Request\r\n'
header: Server: nginx/1.18.0 (Ubuntu)
header: Date: Tue, 16 Jul 2024 09:51:20 GMT
header: Content-Type: text/html
header: Content-Length: 264
header: Connection: close
2024-07-16 09:51:20,678 - DEBUG: http://192.168.10.89:443 "GET /api/ HTTP/1.1" 400 264
2024-07-16 09:51:20,679 - INFO: Successfully connected to NetBox '192.168.10.89'
2024-07-16 09:51:20,679 - DEBUG: Detected NetBox API version: None
ERROR: Unable to determine NetBox version, HTTP header 'API-Version' missing.

Im using NetBox 4.0.2

4 replies

bb-Ricardo Jul 16, 2024
Maintainer

Hi, is NetBox behind a reverse proxy which somehow is misconfigured?

When requesting /api/ you should not receive a HTTP status code 400.

jorge-sevilla Jul 17, 2024

No, i only have the nginx:

I was able to get the HTTP response OK, but the HTTP header still misssing 'API-version':

2024-07-18 10:19:37,059 - INFO: Starting NetBox Sync v1.6.1 (2024-05-14)
2024-07-18 10:19:37,059 - DEBUG: Using config file: /opt/netbox-sync/settings.ini
2024-07-18 10:19:37,059 - DEBUG: Config: common.log_level = INFO
2024-07-18 10:19:37,059 - DEBUG: Config: common.log_to_file = False
2024-07-18 10:19:37,059 - DEBUG: Config: common.log_file = log/netbox_sync.log
2024-07-18 10:19:37,059 - DEBUG: Config: netbox.api_token = d04***
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.host_fqdn = 192.168.10.89
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.port = 443
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.disable_tls = True
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.validate_tls_certs = False
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.proxy = None
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.client_cert = None
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.client_cert_key = None
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.prune_enabled = False
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.prune_delay_in_days = 30
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.ignore_unknown_source_object_pruning = False
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.default_netbox_result_limit = 200
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.timeout = 30
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.max_retry_attempts = 4
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.use_caching = True
2024-07-18 10:19:37,060 - DEBUG: Config: netbox.cache_directory_location = cache
2024-07-18 10:19:37,060 - WARNING: Log level is set to DEBUG3, Request logs will only be printed to console
2024-07-18 10:19:37,060 - DEBUG: Created new requests Session for NetBox.
2024-07-18 10:19:37,062 - DEBUG: Starting new HTTP connection (1): 192.168.10.89:80
send: b'GET /api/ HTTP/1.1\r\nHost: 192.168.10.89\r\nUser-Agent: netbox-sync/1.6.1\r\nAccept-Encoding: gzip, deflate\r\nAccept: /\r\nConnection: keep-alive\r\nAuthorization: Token d04f\r\nContent-Type: application/json\r\n\r\n'
reply: 'HTTP/1.1 301 Moved Permanently\r\n'
header: Server: nginx/1.18.0 (Ubuntu)
header: Date: Thu, 18 Jul 2024 10:19:37 GMT
header: Content-Type: text/html
header: Content-Length: 178
header: Connection: keep-alive
header: Location: https://192.168.10.89/api/
2024-07-18 10:19:37,062 - DEBUG: http://192.168.10.89:80 "GET /api/ HTTP/1.1" 301 178
2024-07-18 10:19:37,063 - DEBUG: Starting new HTTPS connection (1): 192.168.10.89:443
send: b'GET /api/ HTTP/1.1\r\nHost: 192.168.10.89\r\nUser-Agent: netbox-sync/1.6.1\r\nAccept-Encoding: gzip, deflate\r\nAccept: /\r\nConnection: keep-alive\r\nAuthorization: Token d04f\r\n\r\n'
reply: 'HTTP/1.1 200 OK\r\n'
header: Server: nginx/1.18.0 (Ubuntu)
header: Date: Thu, 18 Jul 2024 10:19:37 GMT
header: Content-Type: application/json
header: Content-Length: 549
header: Connection: keep-alive
header: Vary: HX-Request, Accept-Language, Cookie, origin
header: Allow: GET, HEAD, OPTIONS
header: X-Request-ID: 1b72dae1-2976-47d8-9467-e496ae430ba3
header: X-Content-Type-Options: nosniff
header: Referrer-Policy: same-origin
header: Cross-Origin-Opener-Policy: same-origin
header: X-Frame-Options: SAMEORIGIN
header: Content-Language: en
2024-07-18 10:19:37,091 - DEBUG: https://192.168.10.89:443 "GET /api/ HTTP/1.1" 200 549
2024-07-18 10:19:37,091 - INFO: Successfully connected to NetBox '192.168.10.89'
2024-07-18 10:19:37,091 - DEBUG: Detected NetBox API version: None
ERROR: Unable to determine NetBox version, HTTP header 'API-Version' missing.

If i go to the browser, i dont see the header API-Version:

jorge-sevilla Jul 22, 2024

Dont worry about this, i already "fix" the problem by setting the API version manually.

Thanks!!

bb-Ricardo Jul 23, 2024
Maintainer

Hi,

This looks good in the debug output and the screenshot. Strange that the version is missing. Glad you found a workaround

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unable to determine NetBox version, HTTP header 'API-Version' missing. #328

{{title}}

Replies: 2 comments 16 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

Unable to determine NetBox version, HTTP header 'API-Version' missing. #328

Azmodeszer Jul 19, 2023

Replies: 2 comments · 16 replies

bb-Ricardo Jul 19, 2023 Maintainer

Azmodeszer Aug 7, 2023 Author

bb-Ricardo Aug 7, 2023 Maintainer

Azmodeszer Aug 7, 2023 Author

Azmodeszer Aug 7, 2023 Author

jorge-sevilla Jul 16, 2024

bb-Ricardo Jul 16, 2024 Maintainer

jorge-sevilla Jul 17, 2024

jorge-sevilla Jul 22, 2024

bb-Ricardo Jul 23, 2024 Maintainer

Azmodeszer
Jul 19, 2023

Replies: 2 comments 16 replies

bb-Ricardo
Jul 19, 2023
Maintainer

Azmodeszer Aug 7, 2023
Author

bb-Ricardo Aug 7, 2023
Maintainer

Azmodeszer Aug 7, 2023
Author

Azmodeszer Aug 7, 2023
Author

jorge-sevilla
Jul 16, 2024

bb-Ricardo Jul 16, 2024
Maintainer

bb-Ricardo Jul 23, 2024
Maintainer