Skip to content

Lakehouse

All operations require authentication.

8 operationsv2/publicCloud/project
View as Markdown (opens in a new tab)
Agent setup

List the lakehouses of your projectAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse

The list has no region filter: to keep the lakehouses of one region, select them on targetSpec.region.

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Lakehouse[]successful operation
checksum
read-only
string

Hash of the target specification of the lakehouse. Send it back on update to make sure nobody changed the lakehouse in between.

createdAt
read-only
stringdate-time

Date the lakehouse was created

currentState
read-only
LakehouseCurrentState

Current state of the lakehouse, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the lakehouse, and its last failed task while the lakehouse is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the lakehouse

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the lakehouse. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
LakehouseTargetSpec

Last requested specification of the lakehouse

updatedAt
read-only
stringdate-time

Date of the last change to the lakehouse

400objectError 400 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "endpoints": [ { "component": "DATA_CONSOLE", "uri": "string" } ], "name": "string", "networkAccess": { "checkedAt": "2024-01-01T12:00:00Z", "message": "string", "state": "DISABLED" }, "realm": "string", "region": "eu-west-par", "statusReason": { "code": "CANCELED", "message": "string" } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "ipRestrictions": [ { "description": "string", "ip": "192.0.2.0/24" } ], "ipRestrictionsEnabled": true, "name": "string", "region": "eu-west-par" }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a lakehouse of your projectAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Response

200Lakehousesuccessful operation
checksum
read-only
string

Hash of the target specification of the lakehouse. Send it back on update to make sure nobody changed the lakehouse in between.

createdAt
read-only
stringdate-time

Date the lakehouse was created

currentState
read-only
LakehouseCurrentState

Current state of the lakehouse, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the lakehouse, and its last failed task while the lakehouse is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the lakehouse

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the lakehouse. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
LakehouseTargetSpec

Last requested specification of the lakehouse

updatedAt
read-only
stringdate-time

Date of the last change to the lakehouse

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "endpoints": [ { "component": "DATA_CONSOLE", "uri": "string" } ], "name": "string", "networkAccess": { "checkedAt": "2024-01-01T12:00:00Z", "message": "string", "state": "DISABLED" }, "realm": "string", "region": "eu-west-par", "statusReason": { "code": "CANCELED", "message": "string" } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "ipRestrictions": [ { "description": "string", "ip": "192.0.2.0/24" } ], "ipRestrictionsEnabled": true, "name": "string", "region": "eu-west-par" }, "updatedAt": "2024-01-01T12:00:00Z"}

Create a lakehouse in your projectAlpha

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse

Creates the lakehouse asynchronously. The response is the lakehouse in CREATING, with the creation task in currentTasks: follow it on the task routes of the lakehouse, or read the lakehouse until its resourceStatus is READY or ERROR.

The lakehouse is created with its first catalog, described by targetSpec.catalog. That catalog is then a resource of its own: it is listed under the catalogs of the lakehouse, with its own status and its own creation task, and it is not echoed in the targetSpec of the lakehouse. The lakehouse can be READY while its first catalog is still CREATING.

The optional ipRestrictions restricts the source addresses allowed to reach the lakehouse (its Apache Iceberg REST catalog, SQL and S3 endpoints) once ipRestrictionsEnabled is true. Each entry is a public IPv4 or IPv6 block, or a single address, at most 32 entries with at least one IPv4 block. The list is stored normalized: masked, without duplicates, sorted. Enabling filtering needs a region whose ipRestrictions capability is true. Otherwise the creation is refused with a 409. The lakehouse turns READY once the region enforces the list, which currentState.networkAccess shows.

Path parameters

projectId
required
string

Project ID

Request body (required)

targetSpec
required
LakehouseCreationTargetSpec

Specification of the lakehouse to create

Response

200Lakehousesuccessful operation
checksum
read-only
string

Hash of the target specification of the lakehouse. Send it back on update to make sure nobody changed the lakehouse in between.

createdAt
read-only
stringdate-time

Date the lakehouse was created

currentState
read-only
LakehouseCurrentState

Current state of the lakehouse, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the lakehouse, and its last failed task while the lakehouse is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the lakehouse

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the lakehouse. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
LakehouseTargetSpec

Last requested specification of the lakehouse

updatedAt
read-only
stringdate-time

Date of the last change to the lakehouse

400objectError 400 response
409objectError 409 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "endpoints": [ { "component": "DATA_CONSOLE", "uri": "string" } ], "name": "string", "networkAccess": { "checkedAt": "2024-01-01T12:00:00Z", "message": "string", "state": "DISABLED" }, "realm": "string", "region": "eu-west-par", "statusReason": { "code": "CANCELED", "message": "string" } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "ipRestrictions": [ { "description": "string", "ip": "192.0.2.0/24" } ], "ipRestrictionsEnabled": true, "name": "string", "region": "eu-west-par" }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a lakehouse of your projectAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}

Deletes the lakehouse asynchronously. The response is the lakehouse in DELETING, with the deletion task in currentTasks. Once the deletion completes, the lakehouse and every route under it, its tasks included, answer 404. Deleting a lakehouse also deletes its catalogs, schemas, users, groups, members, roles, role assignments, tags and Compute Pools.

A deletion is accepted in READY and ERROR, and also in CREATING and UPDATING, where it replaces the change in progress. A new deletion while one is running is refused with a 409, except a deletion with force set to true on a running deletion that keeps the data, which escalates it.

Without force, the deletion keeps the data and is refused while the lakehouse still holds data: while it holds schemas, the deletion is refused at once with a 409. When only the region knows about the data (tables and views created through Apache Iceberg or SQL), the refusal shows asynchronously as the lakehouse in ERROR, with the status reason code LAKEHOUSE_NOT_EMPTY and the failed task in currentTasks. From that state only a new deletion is accepted, typically with force set to true. With force set to true, the tables, views and data the lakehouse holds are deleted too.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Query parameters

force
boolean

Also delete the tables, views and data it holds. Without it, the deletion is refused while data remains.

Response

200Lakehousesuccessful operation
checksum
read-only
string

Hash of the target specification of the lakehouse. Send it back on update to make sure nobody changed the lakehouse in between.

createdAt
read-only
stringdate-time

Date the lakehouse was created

currentState
read-only
LakehouseCurrentState

Current state of the lakehouse, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the lakehouse, and its last failed task while the lakehouse is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the lakehouse

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the lakehouse. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
LakehouseTargetSpec

Last requested specification of the lakehouse

updatedAt
read-only
stringdate-time

Date of the last change to the lakehouse

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "endpoints": [ { "component": "DATA_CONSOLE", "uri": "string" } ], "name": "string", "networkAccess": { "checkedAt": "2024-01-01T12:00:00Z", "message": "string", "state": "DISABLED" }, "realm": "string", "region": "eu-west-par", "statusReason": { "code": "CANCELED", "message": "string" } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "ipRestrictions": [ { "description": "string", "ip": "192.0.2.0/24" } ], "ipRestrictionsEnabled": true, "name": "string", "region": "eu-west-par" }, "updatedAt": "2024-01-01T12:00:00Z"}

Update a lakehouse of your projectAlpha

PUT
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}

Replaces the lakehouse's target specification as a whole. The body carries the complete desired state of every field publicCloud.lakehouse.LakehouseUpdateTargetSpec exposes — description, ipRestrictions, ipRestrictionsEnabled and name — so read the lakehouse first and restate every value you want to keep: a field left out of targetSpec is cleared, not carried over from the stored specification. ipRestrictions and ipRestrictionsEnabled are required, so that a client unaware of them cannot wipe the allowlist by leaving them out: send the current list and switch to keep them.

The create-only fields catalog and region cannot be changed once the lakehouse exists. They are deliberately absent from the update model, and sending one is rejected with a 400.

A change of ipRestrictions or ipRestrictionsEnabled is applied asynchronously, since the region must enforce it: the response is 202 with the lakehouse UPDATING and the new task in currentTasks, and the lakehouse turns READY once currentState.networkAccess reads ENFORCED (or DISABLED). The list is validated as on creation. ipRestrictionsEnabled true with an empty list is rejected with a 400. Turning filtering off keeps the entries. Enabling filtering or adding addresses needs a region whose ipRestrictions capability is true, otherwise it is refused with a 409. Disabling filtering or removing entries is always accepted.

On a READY lakehouse a change of name or description alone is applied at once: the response is 200 with the lakehouse READY. On a lakehouse in ERROR the change is applied asynchronously, even when the specification is unchanged, to bring the lakehouse out of ERROR: the response is 202 with the lakehouse UPDATING and the new task in currentTasks. The update is refused with a 409 while the lakehouse is CREATING, UPDATING or DELETING, and after a refused deletion, from which only a new deletion is accepted.

The optional checksum guards against a lost update: when supplied it must match the lakehouse's current checksum or the request is rejected with a 409 checksum mismatch. Omitting it skips the check and forces the write (last-write-wins).

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

checksum
string

Checksum of the lakehouse as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the lakehouse changed since. When omitted or empty, no check is made.

targetSpec
required
LakehouseUpdateTargetSpec

New specification of the lakehouse. It replaces the whole current specification: an optional field you omit is reset to its default. Send only the fields of this model: a field that can only be set at creation is refused.

Response

200Lakehousesuccessful operation
checksum
read-only
string

Hash of the target specification of the lakehouse. Send it back on update to make sure nobody changed the lakehouse in between.

createdAt
read-only
stringdate-time

Date the lakehouse was created

currentState
read-only
LakehouseCurrentState

Current state of the lakehouse, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the lakehouse, and its last failed task while the lakehouse is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the lakehouse

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the lakehouse. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a *_NOT_EMPTY status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
LakehouseTargetSpec

Last requested specification of the lakehouse

updatedAt
read-only
stringdate-time

Date of the last change to the lakehouse

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "endpoints": [ { "component": "DATA_CONSOLE", "uri": "string" } ], "name": "string", "networkAccess": { "checkedAt": "2024-01-01T12:00:00Z", "message": "string", "state": "DISABLED" }, "realm": "string", "region": "eu-west-par", "statusReason": { "code": "CANCELED", "message": "string" } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "ipRestrictions": [ { "description": "string", "ip": "192.0.2.0/24" } ], "ipRestrictionsEnabled": true, "name": "string", "region": "eu-west-par" }, "updatedAt": "2024-01-01T12:00:00Z"}

List the events of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/event

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Query parameters

taskId
stringuuid

Return only the events of this task

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Event[]successful operation
createdAt
read-only
stringdate-time

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS
400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/event \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]

List the tasks of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]

Get a task of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task/{taskId}

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}