Skip to content

Recall

All operations require authentication.

5 operationsv1/connectivity/eligibility
Agent setup

List eligibility recallsProduction

GET
/1.0/connectivity/eligibility/recall

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

Response

200EligibilityRecall[]successful operation
completed
read-only
boolean

Is the recall completed ?

completedDate
read-only
stringdate-time

Completed date

creationDate
read-only
stringdate-time

Creation date

customer
read-only
string

customer ID

dedicatedfiberRequest
read-only
boolean

Check for Dedicated Fiber FTTO/FTTE eligibility ?

id
read-only
integer

ID

profiberRequest
read-only
boolean

Check for Pro Fiber FTTH eligibility ?

reference
read-only
string

Reference

referenceType
read-only
ReferenceTypeEnum

Reference type

Valuesaddressbuilding
updatedDate
read-only
stringdate-time

Updated date

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "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" }]

Get an eligibility recallProduction

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

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.

Path parameters

id
required
integer

Id

Response

200EligibilityRecallsuccessful operation
completed
read-only
boolean

Is the recall completed ?

completedDate
read-only
stringdate-time

Completed date

creationDate
read-only
stringdate-time

Creation date

customer
read-only
string

customer ID

dedicatedfiberRequest
read-only
boolean

Check for Dedicated Fiber FTTO/FTTE eligibility ?

id
read-only
integer

ID

profiberRequest
read-only
boolean

Check for Pro Fiber FTTH eligibility ?

reference
read-only
string

Reference

referenceType
read-only
ReferenceTypeEnum

Reference type

Valuesaddressbuilding
updatedDate
read-only
stringdate-time

Updated date

Example uses id = 0

$ curl https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

Create an eligibility recallProduction

POST
/1.0/connectivity/eligibility/recall

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)

dedicatedfiberRequest
boolean

Check for Dedicated Fiber FTTO/FTTE eligibility ?

profiberRequest
boolean

Check for Pro Fiber FTTH eligibility ?

reference
required
string

Reference

referenceType
required
ReferenceTypeEnum

Reference type

Valuesaddressbuilding

Response

200EligibilityRecallsuccessful operation
completed
read-only
boolean

Is the recall completed ?

completedDate
read-only
stringdate-time

Completed date

creationDate
read-only
stringdate-time

Creation date

customer
read-only
string

customer ID

dedicatedfiberRequest
read-only
boolean

Check for Dedicated Fiber FTTO/FTTE eligibility ?

id
read-only
integer

ID

profiberRequest
read-only
boolean

Check for Pro Fiber FTTH eligibility ?

reference
read-only
string

Reference

referenceType
read-only
ReferenceTypeEnum

Reference type

Valuesaddressbuilding
updatedDate
read-only
stringdate-time

Updated date

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

Delete an eligibility recallProduction

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

Deletes the eligibility recall of an address or building reference.

Path parameters

id
required
integer

Id

Response

200—successful operation

Example uses id = 0

$ curl https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an eligibility recallProduction

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

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

Path parameters

id
required
integer

Id

Request body (required)

dedicatedfiberRequest
boolean

Check for Dedicated Fiber FTTO/FTTE eligibility ?

profiberRequest
boolean

Check for Pro Fiber FTTH eligibility ?

reference
required
string

Reference

referenceType
required
ReferenceTypeEnum

Reference type

Valuesaddressbuilding

Response

200EligibilityRecallsuccessful operation
completed
read-only
boolean

Is the recall completed ?

completedDate
read-only
stringdate-time

Completed date

creationDate
read-only
stringdate-time

Creation date

customer
read-only
string

customer ID

dedicatedfiberRequest
read-only
boolean

Check for Dedicated Fiber FTTO/FTTE eligibility ?

id
read-only
integer

ID

profiberRequest
read-only
boolean

Check for Pro Fiber FTTH eligibility ?

reference
read-only
string

Reference

referenceType
read-only
ReferenceTypeEnum

Reference type

Valuesaddressbuilding
updatedDate
read-only
stringdate-time

Updated date

Example uses id = 0

$ curl https://api.eu.ovhcloud.com/1.0/connectivity/eligibility/recall/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}