NetBird Full API Reference + Read-Only MCP Prototype
POST/api/users/invites/{inviteId}/regenerate

Regenerate a user invite

Regenerates an invite link for an existing invite. Invalidates the previous token and creates a new one.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
inviteIdstringrequired
The ID of the invite to regenerate

Regenerate options

expires_inintegeroptional
Invite expiration time in seconds (default 72 hours)

8 status codes
200Invite regenerated successfully
invite_expires_atstringrequired
New invite expiration time
invite_tokenstringrequired
The new invite token
400Bad Request
401Requires authentication
403Forbidden
404Invite not found
412Precondition failed - embedded IdP is not enabled
422Validation failed
500Internal Server Error

Error handling

A 400 is returned: Bad Request. A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 404 is returned: Invite not found. A 412 is returned: Precondition failed - embedded IdP is not enabled. A 422 is returned: Validation failed. A 500 is returned: Internal Server Error.