# Web Cloud › OverTheBox › Service API

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

> 7 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/web-cloud/overthebox/service/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/web-cloud/overthebox/service.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/web-cloud/overthebox/service.json?format=openapi3

## Operations

- `GET /overTheBox` — List OverTheBox services
- `GET /overTheBox/{serviceName}` — Get an OverTheBox service
- `PUT /overTheBox/{serviceName}` — Update an OverTheBox service
- `DELETE /overTheBox/{serviceName}` — Resiliate an OverTheBox service
- `PUT /overTheBox/{serviceName}/autoMTU` — Update the autoMTU of an OverTheBox service
- `POST /overTheBox/{serviceName}/linkDevice` — Link a device to an OverTheBox service
- `POST /overTheBox/{serviceName}/linkHardware` — Link a hardware to an OverTheBox service

## List OverTheBox services

`GET /1.0/overTheBox`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#get-overthebox

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

Returns the names of the OverTheBox services of the account. Each name is the serviceName used by the other OverTheBox calls.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `iamTags` | query | object |  | Filter resources on IAM tags |

### Responses

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

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/overTheBox" \
  -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("/overTheBox")

# 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("/overTheBox");

print_r($result);
?>
```

## Get an OverTheBox service

`GET /1.0/overTheBox/{serviceName}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#get-overthebox-servicename

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

Returns the service status, offer and bandwidth, its operation, tunnel and configuration modes, release channel, IPv6, autoMTU and auto upgrade settings, and the endpoint to query its metrics.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Service name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | otb.serviceWithIAM | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `SOCKSProxyEnabled` | boolean | read-only | Service socks proxy status |
| `autoMTU` | otb.service.activationStatusEnum | read-only | Service auto MTU status — one of `disabled`, `enabled` |
| `autoUpgrade` | boolean | read-only | Service auto upgrade status |
| `bandwidth` | integer | read-only | Service bandwith in bits |
| `configurationMode` | otb.service.configurationModeEnum | read-only | Service description — one of `autoconfigure`, `local` |
| `customerDescription` | string | read-only | Service description |
| `graphEndpoint` | otb.service.graphEndpoint | read-only | Service metrics endpoint |
| `graphEndpoint.host` | string | read-only | The openTSDB host |
| `graphEndpoint.readToken` | string | read-only | The read-only token |
| `graphEndpoint.readTokenID` | string | read-only | The read-only token ID |
| `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 |
| `ipv6Enabled` | boolean | read-only | Service IPv6 status |
| `offer` | string | read-only | Service offer |
| `operationMode` | otb.service.operationModeEnum | read-only | Service operation mode options — one of `overthebox`, `overthebox-legacy`, `wireguard` |
| `prettyOfferName` | string | read-only | Service pretty offer name |
| `releaseChannel` | string | read-only | Service release channel |
| `serviceName` | string | read-only | Service name |
| `status` | otb.service.statusEnum | read-only | Service status — one of `active`, `creating`, `deleted`, `suspended`, `toCreate`, `toDelete` |
| `tunnelMode` | otb.service.tunnelModeEnum | read-only | Service tunnel mode options — one of `glorytun`, `glorytun_hybrid`, `glorytun_mud`, `wireguard` |

```json
{
  "SOCKSProxyEnabled": true,
  "autoMTU": "disabled",
  "autoUpgrade": true,
  "bandwidth": 0,
  "configurationMode": "autoconfigure",
  "customerDescription": "string",
  "graphEndpoint": {
    "host": "string",
    "readToken": "string",
    "readTokenID": "string"
  },
  "iam": {
    "displayName": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "state": "EXPIRED",
    "tags": {
      "key": "string"
    },
    "urn": "string"
  },
  "ipv6Enabled": true,
  "offer": "string",
  "operationMode": "overthebox",
  "prettyOfferName": "string",
  "releaseChannel": "string",
  "serviceName": "string",
  "status": "active",
  "tunnelMode": "glorytun"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}" \
  -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("/overTheBox/{serviceName}")

# 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("/overTheBox/{serviceName}");

print_r($result);
?>
```

## Update an OverTheBox service

`PUT /1.0/overTheBox/{serviceName}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#put-overthebox-servicename

**Status:** Stable production version  
**IAM actions:** `overTheBox:apiovh:put`

Update an OverTheBox service. Changes the settings that can be modified: the customer description, the release channel and the device auto upgrade.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your overTheBox offer |

### Request body (required)

Type: `overTheBox.Service`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `SOCKSProxyEnabled` | boolean | read-only | If the socks proxy is enabled |
| `autoMTU` | overTheBox.AvailableStatusEnum | read-only | The status of the autoMTU — one of `disabled`, `enabled` |
| `autoUpgrade` | boolean |  | Enable device auto upgrade |
| `bandwidth` | integer | read-only | The service maximum bandwidth in bits |
| `configurationMode` | overTheBox.ServiceConfigurationModeEnum | read-only | Configuration mode of the service — one of `autoconfigure`, `local` |
| `customerDescription` | string |  | Editable field for customer |
| `graphEndpoint` | overTheBox.GraphEndpoint | read-only | Parameters needed to fetch metrics |
| `graphEndpoint.host` | string |  | The OpenTSDB host |
| `graphEndpoint.readToken` | string |  | A read-only token |
| `graphEndpoint.readTokenID` | string |  | The read-only token ID |
| `ipv6Enabled` | boolean | read-only | Indicates if IPv6 is enabled |
| `offer` | string | read-only | The service offer |
| `operationMode` | overTheBox.OperationModeEnum | read-only | Operation mode of the service — one of `overthebox`, `overthebox-legacy`, `wireguard` |
| `prettyOfferName` | string | read-only | The service pretty offer name |
| `releaseChannel` | string |  | Release channel of the service |
| `serviceName` | string | read-only | The name of the service |
| `status` | overTheBox.ServiceStatusEnum | read-only | The status of the service — one of `active`, `creating`, `deleted`, `suspended`, `toCreate`, `toDelete` |
| `tunnelMode` | overTheBox.TunnelModeEnum | read-only | The tunnel mode of the service — one of `glorytun`, `glorytun_hybrid`, `glorytun_mud`, `wireguard` |

```json
{
  "autoUpgrade": true,
  "customerDescription": "string",
  "releaseChannel": "string"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}" \
  -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: overTheBox.Service
result = client.put("/overTheBox/{serviceName}",
	autoUpgrade = None, # Enable device auto upgrade (type: boolean)
	customerDescription = None, # Editable field for customer (type: string, nullable)
	releaseChannel = None, # Release channel of the service (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

// Request body type: overTheBox.Service
$result = $ovh->put("/overTheBox/{serviceName}", array(
	autoUpgrade => null, // Enable device auto upgrade (type: boolean)
	customerDescription => null, // Editable field for customer (type: string, nullable)
	releaseChannel => null, // Release channel of the service (type: string)
));

print_r($result);
?>
```

## Resiliate an OverTheBox service

`DELETE /1.0/overTheBox/{serviceName}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#delete-overthebox-servicename

**Status:** Stable production version  
**IAM actions:** `overTheBox:apiovh:delete`

Resiliate an OverTheBox service. Requests the resiliation of the service. Cancel it with cancelResiliation while it is not effective.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your overTheBox offer |

### Responses

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

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}" \
  -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.delete("/overTheBox/{serviceName}")

# 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->delete("/overTheBox/{serviceName}");

print_r($result);
?>
```

## Update the autoMTU of an OverTheBox service

`PUT /1.0/overTheBox/{serviceName}/autoMTU`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#put-overthebox-servicename-automtu

**Status:** Stable production version  
**IAM actions:** `overTheBox:apiovh:autoMTU/edit`

Update the autoMTU of an OverTheBox service. Enables or disables the automatic detection of the MTU on the service.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your overTheBox offer |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `mtuAuto` | overTheBox.AvailableStatusEnum | yes | Enable or disable autoMTU — one of `disabled`, `enabled` |

```json
{
  "mtuAuto": "disabled"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/autoMTU" \
  -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: overTheBox.AvailableStatusEnum
result = client.put("/overTheBox/{serviceName}/autoMTU",
	mtuAuto = None, # Enable or disable autoMTU (type: overTheBox.AvailableStatusEnum)
)

# 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: overTheBox.AvailableStatusEnum
$result = $ovh->put("/overTheBox/{serviceName}/autoMTU", array(
	mtuAuto => null, // Enable or disable autoMTU (type: overTheBox.AvailableStatusEnum)
));

print_r($result);
?>
```

## Link a device to an OverTheBox service

`POST /1.0/overTheBox/{serviceName}/linkDevice`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#post-overthebox-servicename-linkdevice

**Status:** Stable production version  
**IAM actions:** `overTheBox:apiovh:linkDevice`

Link a device to an OverTheBox service. Associates the device, identified by its ID, with the service.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your overTheBox offer |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `deviceId` | string | yes | The id of the device |

```json
{
  "deviceId": "string"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/linkDevice" \
  -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: string
result = client.post("/overTheBox/{serviceName}/linkDevice",
	deviceId = None, # The id of the device (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

// Request body type: string
$result = $ovh->post("/overTheBox/{serviceName}/linkDevice", array(
	deviceId => null, // The id of the device (type: string)
));

print_r($result);
?>
```

## Link a hardware to an OverTheBox service

`POST /1.0/overTheBox/{serviceName}/linkHardware`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/overthebox/service/#post-overthebox-servicename-linkhardware

**Status:** Stable production version  
**IAM actions:** `overTheBox:apiovh:linkHardware`

Link a hardware to an OverTheBox service. Associates one of the available hardware of the account, identified by its name, with the service.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your overTheBox offer |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `hardwareName` | string | yes | The internal name of your hardware |

```json
{
  "hardwareName": "string"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/linkHardware" \
  -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: string
result = client.post("/overTheBox/{serviceName}/linkHardware",
	hardwareName = None, # The internal name of your hardware (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

// Request body type: string
$result = $ovh->post("/overTheBox/{serviceName}/linkHardware", array(
	hardwareName => null, // The internal name of your hardware (type: string)
));

print_r($result);
?>
```