TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-02-20 11:58:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

api.md: add docs for setting an IP address

Browse Source 
Updates tailscale/corp#16453

Signed-off-by: David Crawshaw <crawshaw@tailscale.com>
This commit is contained in:
David Crawshaw 2023-12-19 10:27:01 -08:00 committed by David Crawshaw
parent 01286af82b
commit f815d66a88
1 changed files with 48 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
api.md
View File

@ -60,6 +60,8 @@ The Tailscale API does not currently support pagination. All results are returne
- Update tags: [`POST /api/v2/device/{deviceID}/tags`](#update-device-tags) - Update tags: [`POST /api/v2/device/{deviceID}/tags`](#update-device-tags)
- **Key** - **Key**
- Update device key: [`POST /api/v2/device/{deviceID}/key`](#update-device-key) - Update device key: [`POST /api/v2/device/{deviceID}/key`](#update-device-key)
- **IP Address**
- Set device IPv4 address: [`POST /api/v2/device/{deviceID}/ip`](#set-device-ipv4-address)
**[Tailnet](#tailnet)** **[Tailnet](#tailnet)**
- [**Policy File**](#policy-file) - [**Policy File**](#policy-file)
@ -600,7 +602,7 @@ If the tags supplied in the `POST` call do not exist in the tailnet policy file,
} }
``` ```
<a href="device-key-post"><a> <a href="device-key-post"></a>
## Update device key ## Update device key
@ -654,6 +656,51 @@ curl "https://api.tailscale.com/api/v2/device/11055/key" \
The response is 2xx on success. The response body is currently an empty JSON object. The response is 2xx on success. The response body is currently an empty JSON object.
## Set device IPv4 address
``` http
POST /api/v2/device/{deviceID}/ip
```
Set the Tailscale IPv4 address of the device.
### Parameters
#### `deviceid` (required in URL path)
The ID of the device.
#### `ipv4` (optional in `POST` body)
Provide a new IPv4 address for the device.
When a device is added to a tailnet, its Tailscale IPv4 address is set at random either from the CGNAT range, or a subset of the CGNAT range specified by an [ip pool](https://tailscale.com/kb/1304/ip-pool).
This endpoint can be used to replace the existing IPv4 address with a specific value.
``` jsonc
{
"ipv4": "100.80.0.1"
}
```
This action will break any existing connections to this machine.
You will need to reconnect to this machine using the new IP address.
You may also need to flush your DNS cache.
This returns a 2xx code on success, with an empty JSON object in the response body.
### Request example
``` sh
curl "https://api.tailscale.com/api/v2/device/11055/ip" \
-u "tskey-api-xxxxx:" \
--data-binary '{"ipv4": "100.80.0.1"}'
```
### Response
The response is 2xx on success. The response body is currently an empty JSON object.
# Tailnet # Tailnet
A tailnet is your private network, composed of all the devices on it and their configuration. A tailnet is your private network, composed of all the devices on it and their configuration.