Linode Instances

View IP Address

get
https://api.linode.com/v4/linode/instances/{linodeId}/ips/{address}

View information about the specified IP address associated with the specified Linode.

Authorizations

Personal Access Token
OAuth: ( linodes:read_only)

Path Parameters

linodeId
Required
integer

The ID of the Linode to look up.

address
Required
string

The IP address to look up.

Request Samples

curl -H "Content-Type: application/json" \
    https://api.linode.com/v4/linode/instances/123/ips/97.107.143.141

Response Samples

{
  "public": true,
  "type": "ipv4",
  "region": "us-east",
  "address": "97.107.143.141",
  "gateway": "97.107.143.1",
  "subnet_mask": "255.255.255.0",
  "prefix": 24,
  "rdns": "test.example.org",
  "linode_id": 123
}

Responses

200: A single IP address.

public
boolean

Whether this is a public or private IP address.

type
string
Enum: "ipv4""ipv6""ipv6/pool""ipv6/range"

The type of address this is.

region
Filterable
string

The Region this IP address resides in.

address
string <ip>

The IP address.

gateway
Nullable
string <ip>

The default gateway for this address.

subnet_mask
string <ip>

The mask that separates host bits from network bits for this address.

prefix
integer

The number of bits set in the subnet mask.

rdns
string

The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.

linode_id
integer

The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the /networking/ipv4/assign endpoint. For SLAAC and link-local addresses, this value may not be changed.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Update IP Address

put
https://api.linode.com/v4/linode/instances/{linodeId}/ips/{address}

Updates a particular IP Address associated with this Linode. Only allows setting/resetting reverse DNS.

Authorizations

Personal Access Token
OAuth: ( linodes:read_write)

Path Parameters

linodeId
Required
integer

The ID of the Linode to look up.

address
Required
string

The IP address to look up.

Request Body Schema

rdns
string

The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
      "rdns": "test.example.org"
    }' \
    https://api.linode.com/v4/linode/instances/123/ips/97.107.143.141

Response Samples

{
  "public": true,
  "type": "ipv4",
  "region": "us-east",
  "address": "97.107.143.141",
  "gateway": "97.107.143.1",
  "subnet_mask": "255.255.255.0",
  "prefix": 24,
  "rdns": "test.example.org",
  "linode_id": 123
}

Responses

200: The updated IP address record.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Delete IPv4 Address

delete
https://api.linode.com/v4/linode/instances/{linodeId}/ips/{address}

Deletes a public IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address. Private IPv4 addresses cannot be removed via this endpoint.

Authorizations

Personal Access Token
OAuth: ( linodes:read_write)

Path Parameters

linodeId
Required
integer

The ID of the Linode to look up.

address
Required
string

The IP address to look up.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/linode/instances/123/ips/97.107.143.141

Response Samples

{}

Responses

200: IP address successfully removed.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.