# Web Cloud › Internet › Eligibility › Recall 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

> 5 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/internet/eligibility/recall/

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

## Operations

- `GET /connectivity/eligibility/recall` — List eligibility recalls
- `GET /connectivity/eligibility/recall/{id}` — Get an eligibility recall
- `POST /connectivity/eligibility/recall` — Create an eligibility recall
- `DELETE /connectivity/eligibility/recall/{id}` — Delete an eligibility recall
- `PUT /connectivity/eligibility/recall/{id}` — Update an eligibility recall

## List eligibility recalls

`GET /1.0/connectivity/eligibility/recall`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/eligibility/recall/#get-connectivity-eligibility-recall

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/eligibility/recall/list`

Returns the eligibility recalls of the account, with their address or building reference, the requested fiber offers and whether each one is completed.

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.eligibility.EligibilityRecall[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `completed` | boolean | read-only | Is the recall completed ? |
| `completedDate` | string (date-time) | read-only | Completed date |
| `creationDate` | string (date-time) | read-only | Creation date |
| `customer` | string | read-only | customer ID |
| `dedicatedfiberRequest` | boolean | read-only | Check for Dedicated Fiber FTTO/FTTE eligibility ? |
| `id` | integer | read-only | ID |
| `profiberRequest` | boolean | read-only | Check for Pro Fiber FTTH eligibility ? |
| `reference` | string | read-only | Reference |
| `referenceType` | connectivity.eligibility.ReferenceTypeEnum | read-only | Reference type — one of `address`, `building` |
| `updatedDate` | string (date-time) | read-only | Updated date |

```json
[
  {
    "completed": true,
    "completedDate": "2024-01-01T12:00:00Z",
    "creationDate": "2024-01-01T12:00:00Z",
    "customer": "string",
    "dedicatedfiberRequest": true,
    "id": 0,
    "profiberRequest": true,
    "reference": "string",
    "referenceType": "address",
    "updatedDate": "2024-01-01T12:00:00Z"
  }
]
```

### Example

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

# 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("/connectivity/eligibility/recall");

print_r($result);
?>
```

## Get an eligibility recall

`GET /1.0/connectivity/eligibility/recall/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/eligibility/recall/#get-connectivity-eligibility-recall-id

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/eligibility/recall/get`

Returns an eligibility recall: its address or building reference, the fiber offers it checks (Pro Fiber FTTH, Dedicated Fiber FTTO/FTTE), and its creation, update and completion dates.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | integer | yes | Id |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.eligibility.EligibilityRecall | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `completed` | boolean | read-only | Is the recall completed ? |
| `completedDate` | string (date-time) | read-only | Completed date |
| `creationDate` | string (date-time) | read-only | Creation date |
| `customer` | string | read-only | customer ID |
| `dedicatedfiberRequest` | boolean | read-only | Check for Dedicated Fiber FTTO/FTTE eligibility ? |
| `id` | integer | read-only | ID |
| `profiberRequest` | boolean | read-only | Check for Pro Fiber FTTH eligibility ? |
| `reference` | string | read-only | Reference |
| `referenceType` | connectivity.eligibility.ReferenceTypeEnum | read-only | Reference type — one of `address`, `building` |
| `updatedDate` | string (date-time) | read-only | Updated date |

```json
{
  "completed": true,
  "completedDate": "2024-01-01T12:00:00Z",
  "creationDate": "2024-01-01T12:00:00Z",
  "customer": "string",
  "dedicatedfiberRequest": true,
  "id": 0,
  "profiberRequest": true,
  "reference": "string",
  "referenceType": "address",
  "updatedDate": "2024-01-01T12:00:00Z"
}
```

### Example

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

# 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("/connectivity/eligibility/recall/{id}");

print_r($result);
?>
```

## Create an eligibility recall

`POST /1.0/connectivity/eligibility/recall`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/eligibility/recall/#post-connectivity-eligibility-recall

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/eligibility/recall/create`

Creates a recall on an address or building reference, to check again its eligibility to Pro Fiber FTTH or Dedicated Fiber FTTO/FTTE. Returns the created recall.

### Request body (required)

Type: `connectivity.eligibility.EligibilityRecall.post`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `dedicatedfiberRequest` | boolean |  | Check for Dedicated Fiber FTTO/FTTE eligibility ? |
| `profiberRequest` | boolean |  | Check for Pro Fiber FTTH eligibility ? |
| `reference` | string | yes | Reference |
| `referenceType` | connectivity.eligibility.ReferenceTypeEnum | yes | Reference type — one of `address`, `building` |

```json
{
  "dedicatedfiberRequest": true,
  "profiberRequest": true,
  "reference": "string",
  "referenceType": "address"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.eligibility.EligibilityRecall | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `completed` | boolean | read-only | Is the recall completed ? |
| `completedDate` | string (date-time) | read-only | Completed date |
| `creationDate` | string (date-time) | read-only | Creation date |
| `customer` | string | read-only | customer ID |
| `dedicatedfiberRequest` | boolean | read-only | Check for Dedicated Fiber FTTO/FTTE eligibility ? |
| `id` | integer | read-only | ID |
| `profiberRequest` | boolean | read-only | Check for Pro Fiber FTTH eligibility ? |
| `reference` | string | read-only | Reference |
| `referenceType` | connectivity.eligibility.ReferenceTypeEnum | read-only | Reference type — one of `address`, `building` |
| `updatedDate` | string (date-time) | read-only | Updated date |

```json
{
  "completed": true,
  "completedDate": "2024-01-01T12:00:00Z",
  "creationDate": "2024-01-01T12:00:00Z",
  "customer": "string",
  "dedicatedfiberRequest": true,
  "id": 0,
  "profiberRequest": true,
  "reference": "string",
  "referenceType": "address",
  "updatedDate": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall" \
  -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: connectivity.eligibility.EligibilityRecall.post
result = client.post("/connectivity/eligibility/recall",
	dedicatedfiberRequest = None, # Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)
	profiberRequest = None, # Check for Pro Fiber FTTH eligibility ? (type: boolean)
	reference = None, # Reference (type: string)
	referenceType = None, # Reference type (type: connectivity.eligibility.ReferenceTypeEnum)
)

# 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: connectivity.eligibility.EligibilityRecall.post
$result = $ovh->post("/connectivity/eligibility/recall", array(
	dedicatedfiberRequest => null, // Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)
	profiberRequest => null, // Check for Pro Fiber FTTH eligibility ? (type: boolean)
	reference => null, // Reference (type: string)
	referenceType => null, // Reference type (type: connectivity.eligibility.ReferenceTypeEnum)
));

print_r($result);
?>
```

## Delete an eligibility recall

`DELETE /1.0/connectivity/eligibility/recall/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/eligibility/recall/#delete-connectivity-eligibility-recall-id

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/eligibility/recall/delete`

Deletes the eligibility recall of an address or building reference.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | integer | yes | Id |

### Responses

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

### Example

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

# 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("/connectivity/eligibility/recall/{id}");

print_r($result);
?>
```

## Update an eligibility recall

`PUT /1.0/connectivity/eligibility/recall/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/eligibility/recall/#put-connectivity-eligibility-recall-id

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/eligibility/recall/edit`

Updates the reference and the fiber offers to check of an eligibility recall. Returns the updated recall.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | integer | yes | Id |

### Request body (required)

Type: `connectivity.eligibility.EligibilityRecall.post`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `dedicatedfiberRequest` | boolean |  | Check for Dedicated Fiber FTTO/FTTE eligibility ? |
| `profiberRequest` | boolean |  | Check for Pro Fiber FTTH eligibility ? |
| `reference` | string | yes | Reference |
| `referenceType` | connectivity.eligibility.ReferenceTypeEnum | yes | Reference type — one of `address`, `building` |

```json
{
  "dedicatedfiberRequest": true,
  "profiberRequest": true,
  "reference": "string",
  "referenceType": "address"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.eligibility.EligibilityRecall | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `completed` | boolean | read-only | Is the recall completed ? |
| `completedDate` | string (date-time) | read-only | Completed date |
| `creationDate` | string (date-time) | read-only | Creation date |
| `customer` | string | read-only | customer ID |
| `dedicatedfiberRequest` | boolean | read-only | Check for Dedicated Fiber FTTO/FTTE eligibility ? |
| `id` | integer | read-only | ID |
| `profiberRequest` | boolean | read-only | Check for Pro Fiber FTTH eligibility ? |
| `reference` | string | read-only | Reference |
| `referenceType` | connectivity.eligibility.ReferenceTypeEnum | read-only | Reference type — one of `address`, `building` |
| `updatedDate` | string (date-time) | read-only | Updated date |

```json
{
  "completed": true,
  "completedDate": "2024-01-01T12:00:00Z",
  "creationDate": "2024-01-01T12:00:00Z",
  "customer": "string",
  "dedicatedfiberRequest": true,
  "id": 0,
  "profiberRequest": true,
  "reference": "string",
  "referenceType": "address",
  "updatedDate": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall/{id}" \
  -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: connectivity.eligibility.EligibilityRecall.post
result = client.put("/connectivity/eligibility/recall/{id}",
	dedicatedfiberRequest = None, # Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)
	profiberRequest = None, # Check for Pro Fiber FTTH eligibility ? (type: boolean)
	reference = None, # Reference (type: string)
	referenceType = None, # Reference type (type: connectivity.eligibility.ReferenceTypeEnum)
)

# 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: connectivity.eligibility.EligibilityRecall.post
$result = $ovh->put("/connectivity/eligibility/recall/{id}", array(
	dedicatedfiberRequest => null, // Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)
	profiberRequest => null, // Check for Pro Fiber FTTH eligibility ? (type: boolean)
	reference => null, // Reference (type: string)
	referenceType => null, // Reference type (type: connectivity.eligibility.ReferenceTypeEnum)
));

print_r($result);
?>
```