some file
GET/api/reverse-proxies/proxy-tokens

List Proxy Tokens

Returns all proxy access tokens for the account

Request

GET
/api/reverse-proxies/proxy-tokens
curl -X GET https://api.netbird.io/api/reverse-proxies/proxy-tokens \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

[
  {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "last_used": {
      "type": "string",
      "format": "date-time"
    },
    "revoked": {
      "type": "boolean"
    }
  }
]
POST/api/reverse-proxies/proxy-tokens

Create a Proxy Token

Generate an account-scoped proxy access token for self-hosted proxy registration

Request-Body Parameters

  • Name
    name
    Type
    string
    Required
    required
    Enum
    Description

    Human-readable token name

  • Name
    expires_in
    Type
    integer
    Required
    optional
    Enum
    00
    Description

    Token expiration in seconds (0 = never expires)

Request

POST
/api/reverse-proxies/proxy-tokens
curl -X POST https://api.netbird.io/api/reverse-proxies/proxy-tokens \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
  "name": "my-proxy-token",
  "expires_in": 0
}'

Response

{
  "id": {
    "type": "string"
  },
  "name": {
    "type": "string"
  },
  "expires_at": {
    "type": "string",
    "format": "date-time"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  },
  "last_used": {
    "type": "string",
    "format": "date-time"
  },
  "revoked": {
    "type": "boolean"
  },
  "plain_token": "nbx_abc123..."
}
DELETE/api/reverse-proxies/proxy-tokens/{tokenId}

Revoke a Proxy Token

Revoke an account-scoped proxy access token

Path Parameters

  • Name
    tokenId
    Type
    string
    Required
    required
    Enum
    Description

    The unique identifier of the proxy token

Request

DELETE
/api/reverse-proxies/proxy-tokens/{tokenId}
curl -X DELETE https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId} \
-H 'Authorization: Token <TOKEN>'