# Network › IP addresses › Configuration API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Network product's sections: https://developers.eu.ovhcloud.com/reference/network/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 6 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/network/ip-addresses/configuration.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/network/ip-addresses/configuration.json?format=openapi3

## Operations

- `GET /ip` — List IPs
- `GET /ip/{ip}/move` — List move destinations
- `GET /ip/{ip}` — Get an IP
- `POST /ip/{ip}/move` — Move an IP
- `POST /ip/{ip}/park` — Park an IP
- `PUT /ip/{ip}` — Update the IP description

## List IPs

`GET /1.0/ip`

Link: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/#get-ip

**Status:** Stable production version  
**IAM actions:** `ip:apiovh:get`

List IPs. Returns your IP blocks, filterable by routed service, type, version, campus, Additional IP or IAM tags.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campus` | query | string |  | Filter the value of campus property (ilike) (alpha) |
| `description` | query | string |  | Filter the value of description property (like) |
| `iamTags` | query | object |  | Filter resources on IAM tags |
| `ip` | query | ipBlock |  | Filter the value of ip property (contains or equals) |
| `isAdditionalIp` | query | boolean |  | Filter the value of isAdditionalIp property (=) (alpha) |
| `routedTo.serviceName` | query | string |  | Filter the value of routedTo.serviceName property (like) |
| `type` | query | ip.IpTypeEnum |  | Filter the value of type property (=) — one of `cdn`, `cloud`, `dedicated`, `failover`, `hosted_ssl`, `housing`, `loadBalancing`, `mail`, `overthebox`, `pcc`, `pci`, `private`, … |
| `version` | query | ip.IpVersionEnum |  | Filter the value of version property (=) (alpha) — one of `4`, `6` |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | ipBlock[] | successful operation |

```json
[
  "192.0.2.0/24"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/ip" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/ip")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/ip");

print_r($result);
?>
```

## List move destinations

`GET /1.0/ip/{ip}/move`

Link: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/#get-ip-ip-move

**Status:** Beta version  
**IAM actions:** `ip:apiovh:move/get`, `dedicatedServer:apiovh:ip/additionalIp/move`, `pccVMware:apiovh:ip/additionalIp/move`, `publicCloudProject:apiovh:ip/additionalIp/move`, `vps:apiovh:ip/additionalIp/move`, `loadbalancer:apiovh:ip/additionalIp/move`, `vrack:apiovh:ip/additionalIp/move`, `vmwareCloudDirector:apiovh:organization/ip/additionalIp/move`, `vrackServices:apiovh:bgp/ip/additionalIp/move`

List move destinations. Returns, per service type, the services this IP can move to and their next hops.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `ip` | path | ipBlock | yes | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | ip.Destinations | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cloudProject` | ip.Destination[] |  | list of public cloud projects |
| `cloudProject[].nexthop` | string[] |  | Nexthops available on this service |
| `cloudProject[].service` | string |  | Service destination |
| `dedicatedCloud` | ip.Destination[] |  | list of dedicated clouds |
| `dedicatedCloud[].nexthop` | string[] |  | Nexthops available on this service |
| `dedicatedCloud[].service` | string |  | Service destination |
| `dedicatedServer` | ip.Destination[] |  | list of dedicated servers |
| `dedicatedServer[].nexthop` | string[] |  | Nexthops available on this service |
| `dedicatedServer[].service` | string |  | Service destination |
| `hostingReseller` | ip.Destination[] |  | list of hosting reseller services |
| `hostingReseller[].nexthop` | string[] |  | Nexthops available on this service |
| `hostingReseller[].service` | string |  | Service destination |
| `ipLoadbalancing` | ip.Destination[] |  | list of load balancing services |
| `ipLoadbalancing[].nexthop` | string[] |  | Nexthops available on this service |
| `ipLoadbalancing[].service` | string |  | Service destination |
| `sncCloudPlatform` | ip.Destination[] |  | list of SNC Cloud Platform projects |
| `sncCloudPlatform[].nexthop` | string[] |  | Nexthops available on this service |
| `sncCloudPlatform[].service` | string |  | Service destination |
| `vmwareCloudDirector` | ip.Destination[] |  | list of VMware Cloud Director organization services |
| `vmwareCloudDirector[].nexthop` | string[] |  | Nexthops available on this service |
| `vmwareCloudDirector[].service` | string |  | Service destination |
| `vps` | ip.Destination[] |  | list of vps |
| `vps[].nexthop` | string[] |  | Nexthops available on this service |
| `vps[].service` | string |  | Service destination |
| `vrackServicesBgp` | ip.Destination[] |  | list of BGP vrack services services |
| `vrackServicesBgp[].nexthop` | string[] |  | Nexthops available on this service |
| `vrackServicesBgp[].service` | string |  | Service destination |

```json
{
  "cloudProject": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "dedicatedCloud": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "dedicatedServer": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "hostingReseller": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "ipLoadbalancing": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "sncCloudPlatform": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "vmwareCloudDirector": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "vps": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ],
  "vrackServicesBgp": [
    {
      "nexthop": [
        "string"
      ],
      "service": "string"
    }
  ]
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/ip/{ip}/move" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/ip/{ip}/move")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/ip/{ip}/move");

print_r($result);
?>
```

## Get an IP

`GET /1.0/ip/{ip}`

Link: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/#get-ip-ip

**Status:** Stable production version  
**IAM actions:** `ip:apiovh:get`

Get an IP. Returns the block's type, routed service, regions, RIR, organization, and BYOIP / Additional IP flags.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `ip` | path | ipBlock | yes | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | ip.IpWithIAM | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `bringYourOwnIp` | boolean | read-only | Is this IP part of the Bring your own IP program (alpha) |
| `campus` | string | read-only | Where is the IP used/usable (alpha) |
| `canBeTerminated` | boolean | read-only | Is this IP can be terminated |
| `country` | coreTypes.CountryEnum | read-only | IP country — one of `ac`, `ad`, `ae`, `af`, `ag`, `ai`, `al`, `am`, `an`, `ao`, `aq`, `ar`, … |
| `description` | string |  | Custom description on your ip |
| `iam` | iam.ResourceMetadata | read-only | IAM resource metadata |
| `iam.displayName` | string | read-only | Resource display name |
| `iam.id` | string (uuid) | read-only | Unique identifier of the resource |
| `iam.state` | iam.ResourceMetadata.StateEnum | read-only | Resource state — one of `EXPIRED`, `IN_CREATION`, `OK`, `SUSPENDED` |
| `iam.tags` | object | read-only | Resource tags. Tags that were internally computed are prefixed with ovh: |
| `iam.urn` | string | read-only | Unique resource name used in policies |
| `ip` | ipBlock | read-only | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |
| `isAdditionalIp` | boolean | read-only | Is this IP an Additional IP (alpha) |
| `organisationId` | string | read-only | IP block organisation Id |
| `regions` | coreTypes.RegionCodenameEnum[] | read-only | Where is the IP used/usable, in the form of region codenames (alpha) |
| `rir` | string | read-only | Regional Internet Registry of the IP (alpha) |
| `routedTo` | ip.RoutedTo | read-only | Routage information |
| `routedTo.serviceName` | string |  | Service where ip is routed to |
| `type` | ip.IpTypeEnum | read-only | Possible values for ip type — one of `cdn`, `cloud`, `dedicated`, `failover`, `hosted_ssl`, `housing`, `loadBalancing`, `mail`, `overthebox`, `pcc`, `pci`, `private`, … |
| `version` | ip.IpVersionEnum | read-only | Version of the IP (alpha) — one of `4`, `6` |

```json
{
  "bringYourOwnIp": true,
  "campus": "string",
  "canBeTerminated": true,
  "country": "ac",
  "description": "string",
  "iam": {
    "displayName": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "state": "EXPIRED",
    "tags": {
      "key": "string"
    },
    "urn": "string"
  },
  "ip": "192.0.2.0/24",
  "isAdditionalIp": true,
  "organisationId": "string",
  "regions": [
    "af-central-lz-abj"
  ],
  "rir": "string",
  "routedTo": {
    "serviceName": "string"
  },
  "type": "cdn",
  "version": 4
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/ip/{ip}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/ip/{ip}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/ip/{ip}");

print_r($result);
?>
```

## Move an IP

`POST /1.0/ip/{ip}/move`

Link: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/#post-ip-ip-move

**Status:** Stable production version  
**IAM actions:** `ip:apiovh:move`, `dedicatedServer:apiovh:ip/additionalIp/move`, `pccVMware:apiovh:ip/additionalIp/move`, `publicCloudProject:apiovh:ip/additionalIp/move`, `vps:apiovh:ip/additionalIp/move`, `loadbalancer:apiovh:ip/additionalIp/move`, `vrack:apiovh:ip/additionalIp/move`, `vmwareCloudDirector:apiovh:organization/ip/additionalIp/move`, `vrackServices:apiovh:bgp/ip/additionalIp/move`

Move an IP. Routes the IP to another service of your account, with an optional next hop (async task).

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `ip` | path | ipBlock | yes | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `nexthop` | string |  | Nexthop of destination service |
| `to` | string | yes | Service destination |

```json
{
  "nexthop": "string",
  "to": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | ip.IpTask | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | string | read-only | Details of this task |
| `destination` | ip.RoutedTo | read-only | Destination for moveFloatingIp tasks |
| `destination.serviceName` | string |  | Service where ip is routed to |
| `doneDate` | string (date-time) | read-only | Completion date |
| `function` | ip.TaskFunctionEnum | read-only | Function name — one of `arinBlockReassign`, `changeRipeOrg`, `checkAndReleaseIp`, `genericMoveFloatingIp`, `supernetByoipFailoverPartitioning` |
| `lastUpdate` | string (date-time) | read-only | last update |
| `startDate` | string (date-time) | read-only | Task Creation date |
| `status` | ip.TaskStatusEnum | read-only | Task status — one of `cancelled`, `customerError`, `doing`, `done`, `init`, `ovhError`, `todo` |
| `taskId` | integer | read-only | the id of the task |

```json
{
  "comment": "string",
  "destination": {
    "serviceName": "string"
  },
  "doneDate": "2024-01-01T12:00:00Z",
  "function": "arinBlockReassign",
  "lastUpdate": "2024-01-01T12:00:00Z",
  "startDate": "2024-01-01T12:00:00Z",
  "status": "cancelled",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/ip/{ip}/move" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/ip/{ip}/move",
	nexthop = None, # Nexthop of destination service (type: string, nullable)
	to = None, # Service destination (type: string)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/ip/{ip}/move", array(
	nexthop => null, // Nexthop of destination service (type: string, nullable)
	to => null, // Service destination (type: string)
));

print_r($result);
?>
```

## Park an IP

`POST /1.0/ip/{ip}/park`

Link: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/#post-ip-ip-park

**Status:** Stable production version  
**IAM actions:** `ip:apiovh:park`

Park an IP. Detaches the IP from its service and keeps it on your account, unrouted. Returns the task that applies the change.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `ip` | path | ipBlock | yes | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | ip.IpTask | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | string | read-only | Details of this task |
| `destination` | ip.RoutedTo | read-only | Destination for moveFloatingIp tasks |
| `destination.serviceName` | string |  | Service where ip is routed to |
| `doneDate` | string (date-time) | read-only | Completion date |
| `function` | ip.TaskFunctionEnum | read-only | Function name — one of `arinBlockReassign`, `changeRipeOrg`, `checkAndReleaseIp`, `genericMoveFloatingIp`, `supernetByoipFailoverPartitioning` |
| `lastUpdate` | string (date-time) | read-only | last update |
| `startDate` | string (date-time) | read-only | Task Creation date |
| `status` | ip.TaskStatusEnum | read-only | Task status — one of `cancelled`, `customerError`, `doing`, `done`, `init`, `ovhError`, `todo` |
| `taskId` | integer | read-only | the id of the task |

```json
{
  "comment": "string",
  "destination": {
    "serviceName": "string"
  },
  "doneDate": "2024-01-01T12:00:00Z",
  "function": "arinBlockReassign",
  "lastUpdate": "2024-01-01T12:00:00Z",
  "startDate": "2024-01-01T12:00:00Z",
  "status": "cancelled",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/ip/{ip}/park" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/ip/{ip}/park")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/ip/{ip}/park");

print_r($result);
?>
```

## Update the IP description

`PUT /1.0/ip/{ip}`

Link: https://developers.eu.ovhcloud.com/reference/network/ip-addresses/configuration/#put-ip-ip

**Status:** Stable production version  
**IAM actions:** `ip:apiovh:edit`

Update the IP description. Changes the block's free-text description, its only editable field. List IPs can filter on this description.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `ip` | path | ipBlock | yes | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |

### Request body (required)

Type: `ip.Ip`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `bringYourOwnIp` | boolean | read-only | Is this IP part of the Bring your own IP program (alpha) |
| `campus` | string | read-only | Where is the IP used/usable (alpha) |
| `canBeTerminated` | boolean | read-only | Is this IP can be terminated |
| `country` | coreTypes.CountryEnum | read-only | IP country — one of `ac`, `ad`, `ae`, `af`, `ag`, `ai`, `al`, `am`, `an`, `ao`, `aq`, `ar`, … |
| `description` | string |  | Custom description on your ip |
| `ip` | ipBlock | read-only | IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) |
| `isAdditionalIp` | boolean | read-only | Is this IP an Additional IP (alpha) |
| `organisationId` | string | read-only | IP block organisation Id |
| `regions` | coreTypes.RegionCodenameEnum[] | read-only | Where is the IP used/usable, in the form of region codenames (alpha) |
| `rir` | string | read-only | Regional Internet Registry of the IP (alpha) |
| `routedTo` | ip.RoutedTo | read-only | Routage information |
| `routedTo.serviceName` | string |  | Service where ip is routed to |
| `type` | ip.IpTypeEnum | read-only | Possible values for ip type — one of `cdn`, `cloud`, `dedicated`, `failover`, `hosted_ssl`, `housing`, `loadBalancing`, `mail`, `overthebox`, `pcc`, `pci`, `private`, … |
| `version` | ip.IpVersionEnum | read-only | Version of the IP (alpha) — one of `4`, `6` |

```json
{
  "description": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/ip/{ip}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: ip.Ip
result = client.put("/ip/{ip}",
	description = None, # Custom description on your ip (type: string, nullable)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: ip.Ip
$result = $ovh->put("/ip/{ip}", array(
	description => null, // Custom description on your ip (type: string, nullable)
));

print_r($result);
?>
```