2.6 KiB
title | description | tags | keywords |
---|---|---|---|
API tokens | This article explains how to create and work with API Tokens. | [Account Settings Api Tokens] | [api tokens create api token delete api token] |
Create API Token
Open Account Settings page from the user menu in the bottom left corner of the sidebar.
- Click on
User menu
in the bottom left corner of the sidebar, - Select
Account Settings
from the dropdown
Follow the steps below to create API Token
- Click on
Tokens
tab in theAccount Settings
page - Click on
Add New API Token
- Enter the name for the API Token
- Click on
Save
button to save the changes - Copy the API Token by clicking on
Copy
button displayed underActions
menu - Use the API Token in the services that require it to authenticate as
xc-token
in the headers.
{
"headers": {
"xc-token": "Copied API token here under quotes"
}
}
:::info
- Only one token can be created per user
- API Token does not expire, but it can be deleted anytime. :::
API Token created will get added to the list. Copy API token by clicking on Copy
button displayed under Actions
menu
Delete API Token
:::warning Note that, all the services using the API Token will stop working once the API Token is deleted. :::
Open Account Settings page from the user menu in the bottom left corner of the sidebar.
- Click on
User menu
in the bottom left corner of the sidebar, - Select
Account Settings
from the dropdown
- Click on
Tokens
tab in theAccount Settings
page - From the
Actions
menu, click onDelete
button associated with the API Token to be deleted
Auth Tokens
:::warning Use of Auth tokens is deprecated since v0.205.1. Please use API Tokens for authentication. :::
For quick experiments with the API, you can use the Auth Tokens
to generate a temporary token. These tokens are valid for a session until the user logs out or for 10 hours.
Follow the steps below to copy AUTH Token
- Click on
User menu
in the bottom left corner of the sidebar, - Select
Copy Auth Token
from the dropdown
{
"headers": {
"xc-auth": "Copied auth token here under quotes"
}
}
:::note
For Self-hosted, you can reconfigure expiry time using environment variable NC_JWT_EXPIRES_IN
. This defaults to 10 hours.
:::