NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-18 19:32:24 -06:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

Reset documentation hierarchy

Browse Source
This commit is contained in:
Jeremy Stretch
2020-03-05 17:23:56 -05:00
parent a1351e2471
commit 683f358ebb
21 changed files with 110 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/authentication.md
View File

@@ -1,6 +1,8 @@
# REST API Authentication
The NetBox API employs token-based authentication. For convenience, cookie authentication can also be used when navigating the browsable API.
# Tokens
## Tokens
A token is a unique identifier that identifies a user to the API. Each user in NetBox may have one or more tokens which he or she can use to authenticate to the API. To create a token, navigate to the API tokens page at `/user/api-tokens/`.
@@ -13,7 +15,7 @@ By default, a token can be used for all operations available via the API. Desele
Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox.
# Authenticating to the API
## Authenticating to the API
By default, read operations will be available without authentication. In this case, a token may be included in the request, but is not necessary.