List all Setup Keys
Returns a list of all Setup Keys
Request
curl -X GET https://api.netbird.io/api/setup-keys \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Response
[
{
"id": 2531583362,
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0,
"ephemeral": true
}
]
Create a Setup Key
Creates a setup key
Request-Body Parameters
- Name
name
- Type
- string
- Required
- required
- Enum
- Description
Setup Key name
- Name
type
- Type
- string
- Required
- required
- Enum
- Description
Setup key type, one-off for single time usage and reusable
- Name
expires_in
- Type
- integer
- Required
- required
- Enum
- Possible Values:
>=86400
and <=31536000
- Description
Expiration time in seconds
- Name
auto_groups
- Type
- string[]
- Required
- required
- Enum
- Description
List of group IDs to auto-assign to peers registered with this key
- Name
usage_limit
- Type
- integer
- Required
- required
- Enum
- Description
A number of times this key can be used. The value of 0 indicates the unlimited usage.
- Name
ephemeral
- Type
- boolean
- Required
- optional
- Enum
- Description
Indicate that the peer will be ephemeral or not
Request
curl -X POST https://api.netbird.io/api/setup-keys \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"name": "Default key",
"type": "reusable",
"expires_in": 86400,
"auto_groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"usage_limit": 0,
"ephemeral": true
}'
Response
{
"id": 2531583362,
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0,
"ephemeral": true
}
Retrieve a Setup Key
Get information about a setup key
Path Parameters
- Name
keyId
- Type
- string
- Required
- required
- Enum
- Description
The unique identifier of a setup key
Request
curl -X GET https://api.netbird.io/api/setup-keys/{keyId} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Response
{
"id": 2531583362,
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0,
"ephemeral": true
}
Update a Setup Key
Update information about a setup key
Path Parameters
- Name
keyId
- Type
- string
- Required
- required
- Enum
- Description
The unique identifier of a setup key
Request-Body Parameters
- Name
name
- Type
- string
- Required
- required
- Enum
- Description
Setup Key name
- Name
type
- Type
- string
- Required
- required
- Enum
- Description
Setup key type, one-off for single time usage and reusable
- Name
expires_in
- Type
- integer
- Required
- required
- Enum
- 00
- Description
Expiration time in seconds, 0 will mean the key never expires
- Name
revoked
- Type
- boolean
- Required
- required
- Enum
- Description
Setup key revocation status
- Name
auto_groups
- Type
- string[]
- Required
- required
- Enum
- Description
List of group IDs to auto-assign to peers registered with this key
- Name
usage_limit
- Type
- integer
- Required
- required
- Enum
- Description
A number of times this key can be used. The value of 0 indicates the unlimited usage.
- Name
ephemeral
- Type
- boolean
- Required
- optional
- Enum
- Description
Indicate that the peer will be ephemeral or not
Request
curl -X PUT https://api.netbird.io/api/setup-keys/{keyId} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"name": "Default key",
"type": "reusable",
"expires_in": 86400,
"revoked": false,
"auto_groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"usage_limit": 0,
"ephemeral": true
}'
Response
{
"id": 2531583362,
"key": "A616097E-FCF0-48FA-9354-CA4A61142761",
"name": "Default key",
"expires": "2023-06-01T14:47:22.291057Z",
"type": "reusable",
"valid": true,
"revoked": false,
"used_times": 2,
"last_used": "2023-05-05T09:00:35.477782Z",
"state": "valid",
"auto_groups": [
"ch8i4ug6lnn4g9hqv7m0"
],
"updated_at": "2023-05-05T09:00:35.477782Z",
"usage_limit": 0,
"ephemeral": true
}
Delete a Setup Key
Delete a Setup Key
Path Parameters
- Name
keyId
- Type
- string
- Required
- required
- Enum
- Description
The unique identifier of a setup key
Request
curl -X DELETE https://api.netbird.io/api/setup-keys/{keyId} \
-H 'Authorization: Token <TOKEN>'