Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tailscale Invites API

The Invites API from Tailscale — 7 operation(s) for invites.

Tailscale Invites API is one of 7 APIs that Tailscale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invites. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 7 paths. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against a single base URL, https://api.tailscale.com/api/v2.

11 operations 7 paths 0 schemas 2 DELETE4 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api.tailscale.com/api/v2
Authentication
HTTP Bearer, HTTP Basic
Contact
Resource Areas
1

Authentication & Security 2

Tailscale Invites API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BearerAuth — Tailscale API access token (prefixed "tskey-api-") passed in the Authorization header. Tokens are created in the admin console with 1-90 day expiry, or via OAu…
  • BasicAuth — HTTP Basic Auth with the access token as the username and an empty password.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Invites 11
GET
/device/{deviceId}/device-invites
List device invites for a device
listDeviceInvitesForDevice 1 param → 200
POST
/device/{deviceId}/device-invites
Create device invite for a device
createDeviceInvite 1 param → 201
GET
/tailnet/{tailnet}/user-invites
List tailnet user invites
listUserInvites 1 param → 200
POST
/tailnet/{tailnet}/user-invites
Create user invite
createUserInvite 1 param → 201
GET
/user-invites/{userInviteId}
Get user invite
getUserInvite 1 param → 200
DELETE
/user-invites/{userInviteId}
Delete user invite
deleteUserInvite 1 param → 204
POST
/user-invites/{userInviteId}/resend
Resend user invite
resendUserInvite 1 param → 200
GET
/device-invites/{deviceInviteId}
Get device invite
getDeviceInvite 1 param → 200
DELETE
/device-invites/{deviceInviteId}
Delete device invite
deleteDeviceInvite 1 param → 204
POST
/device-invites/{deviceInviteId}/resend
Resend device invite
resendDeviceInvite 1 param → 200
POST
/device-invites/-/accept
Accept a device invite
acceptDeviceInvite → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tailscale-invites-api-openapi.yml Raw ↑

Other APIs Tailscale publishes across the network.

Tailscale Devices API
Tailscale DNS API
Tailscale Keys API
Tailscale Logging API
Tailscale Policy API
Tailscale Tailnet API