Observability
All operations require authentication.
List incidentsProduction
Returns the IDs of the incidents and planned maintenances affecting the service.
Path parameters
Service name
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ 0]
List log kindsProduction
Returns the names of the log kinds OVHcloud Connect emits, which can be forwarded to a stream.
Path parameters
Service name
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ "string"]
List interfacesProduction
Returns the IDs of the service's physical ports.
Path parameters
Service name
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ 0]
List log subscriptionsProduction
Returns the identifiers of the OVHcloud Connect log subscriptions. Set kind to restrict the list to one log kind.
Path parameters
Service name
Query parameters
Filter on a specific kind (e.g., audit)
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ "00000000-0000-0000-0000-000000000000"]
List notificationsProduction
Returns each alert type available on the service and whether it is active.
Path parameters
Service name
Response
Whether alert is activated
Description of the monitoring alert
Name of the monitoring alert
Type of the monitoring alert
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "activated": true, "description": "string", "name": "string", "type": "string" }]
Get incidentProduction
Returns whether it is an incident or a maintenance, with its start and end dates.
Path parameters
Id
Service name
Response
Ending date of the incident
Incident reference
Starting date of the incident
Type of incident
incidentmaintenanceExample uses id = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "endDate": "2024-01-01T12:00:00Z", "id": 0, "startDate": "2024-01-01T12:00:00Z", "type": "incident"}
Get a log kindProduction
Returns a log kind and the additional fields its logs carry.
Path parameters
Name
Service name
Response
List of additional log fields managed in this log kind
Creation date of the log kind
Log kind display name
Log kind ID
Log kind name
Last update date of the log kind
Example uses name = string, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "additionalReturnedFields": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "displayName": "string", "kindId": "00000000-0000-0000-0000-000000000000", "name": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get interfaceProduction
Returns the port's location, patch panel, status, connector type and optical light levels.
Path parameters
Id
Service name
Response
Patch panel name
Equipment name in the rack
Interface reference
Status of the light received on the port (checked every 5 min)
downunknownupValue of the light received on the port (checked every 5 min)
Port location
Status of the interface
downunknownupDate of the last interface status change detected
Fiber termination type
LC/PCSC/PCDate of the last light change detected
Status of the light emitted on the port (checked every 5 min)
downunknownupValue of the light emitted on the port (checked every 5 min)
Status of the port
disabledenabledreservedExample uses id = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "deviceDisplayName": "string", "deviceRackDisplayName": "string", "id": 0, "incomingLightStatus": "down", "incomingLightValue": 0, "interfaceName": "string", "interfaceStatus": "down", "interfaceStatusLastUpdate": "2024-01-01T12:00:00Z", "interfaceTerminationType": "LC/PC", "lightLastUpdate": "2024-01-01T12:00:00Z", "outgoingLightStatus": "down", "outgoingLightValue": 0, "status": "disabled"}
Get a log subscriptionProduction
Returns the log kind and the destination stream of a subscription.
Path parameters
Service name
Subscription ID
Response
Creation date of the subscription
Log kind name of this subscription
Subscribed resource, where the logs come from
Name of the destination log service
Id of the destination log stream
Subscription ID
Last update date of the subscription
Example uses serviceName = 00000000-0000-0000-0000-000000000000, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "resource": { "name": "string", "type": "string" }, "serviceName": "string", "streamId": "string", "subscriptionId": "00000000-0000-0000-0000-000000000000", "updatedAt": "2024-01-01T12:00:00Z"}
Create a log subscriptionProduction
Forwards OVHcloud Connect logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.
Path parameters
Service name
Request body (required)
Log kind name to subscribe to
Customer log stream ID
Response
Identifier of the operation
Operation owner's service name
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}
Get BGP session statusBeta
Returns whether the L3 BGP session is up or down, with its flap count and last changes.
Path parameters
Pop ID
Service name
Response
Number of flap since last UP
Last time the interface changed status
Last time the interface status went from up to down
Last time the session flapped
Last time the interface status went from down to up
Last time the status was updated
Status of the peering
downupExample uses popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "flapCount": 0, "lastChange": "2024-01-01T12:00:00Z", "lastDown": "2024-01-01T12:00:00Z", "lastFlap": "2024-01-01T12:00:00Z", "lastUp": "2024-01-01T12:00:00Z", "lastUpdate": "2024-01-01T12:00:00Z", "status": "down"}
Generate a temporary log URLProduction
Generates a temporary URL to read the logs of one kind. The URL expires.
Path parameters
Service name
Request body (required)
Log kind name
Response
Temporary url expiration date
Temporary url
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "expirationDate": "2024-01-01T12:00:00Z", "url": "string"}
Get BGP prefix statisticsBeta
Returns accepted BGP prefixes and the prefix limit over time for this PoP configuration.
Path parameters
Pop ID
Service name
Query parameters
The period the statistics are fetched for
dailyhourlyweeklyThe type of statistic to be fetched
prefix:acceptedprefix:limitResponse
timestamp corresponding to the value
OVHcloud Connect Metrics value
Example uses popId = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "timestamp": 0, "value": { "unit": "bits/s", "value": 0 } }]
Get interface statusBeta
Returns whether the port is up or down, with its last up, down and change times.
Path parameters
Id
Service name
Response
Last time the interface changed status
Last time the interface status went from up to down
Last time the interface status went from down to up
Last time the status was updated
Status of the interface
downupExample uses id = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "lastChange": "2024-01-01T12:00:00Z", "lastDown": "2024-01-01T12:00:00Z", "lastUp": "2024-01-01T12:00:00Z", "lastUpdate": "2024-01-01T12:00:00Z", "status": "down"}
Get interface statisticsProduction
Returns a time series of traffic, errors or optical levels for the chosen period.
Path parameters
Id
Service name
Query parameters
The period the statistics are fetched for
dailyhourlyweeklyThe type of statistic to be fetched
error:downloaderror:uploadlight:inlight:outtraffic:downloadtraffic:downloadBpstraffic:uploadtraffic:uploadBpsResponse
timestamp corresponding to the value
OVHcloud Connect Metrics value
Example uses id = 0, serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "timestamp": 0, "value": { "unit": "bits/s", "value": 0 } }]
Delete a log subscriptionProduction
Deletes the subscription and stops forwarding OVHcloud Connect logs to the stream.
Path parameters
Service name
Subscription ID
Response
Identifier of the operation
Operation owner's service name
Example uses serviceName = 00000000-0000-0000-0000-000000000000, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}
Set notificationsProduction
Activates exactly the alert types listed; any type left out is turned off.
Path parameters
Service name
Request body (required)
List of subscriptions alerts.
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/Disable all notificationsProduction
Turns off every alert of the service.
Path parameters
Service name
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/