Data Platform APIs

What the APIs cover

The Data Platform APIs are the programmatic alternative to the interface, for building and managing a project in code rather than by hand.

Until then, two other routes cover most programmatic work. The Custom Actions SDK reads and writes datasets, tables and buckets from inside a project's own compute. Project buckets speak S3¹, so any S3-compatible client works against them directly, as the bucket access tutorial shows.

The conventions below apply to the authentication endpoints and to the API as it grows.

General formats

Response format

• Data format: JSON see http://www.json.org
• Character set: UTF-8
• All non-empty responses are sent with the header: Content-Type: application/json; charset=utf-8

HTTP response codes

Error handling

In case of client-side (HTTP status code 4xx) or server-side (HTTP status code 5xx) error, the response body may contain a JSON object describing the error:

{
   "error": "Invalid parameter", // code 400, 403, 500
   "warning": "Action not found" // code 404
}

Timestamp

All data endpoints return the timestamp associated with the data provided.

{
    "timestamp": 1435929960
}

Duration

All data endpoints return the duration attribute. It represents the effective time taken by the system to execute a request in seconds.

{
    "duration": 0.056
}

Go further

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

If you need support with your OVHcloud services, create a request in our Help Centre.

Join our community of users.

¹: S3 is a trademark of Amazon Technologies, Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies, Inc.