{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.CurrentTask":{"type":"object","description":"Asynchronous operation currently running","properties":{"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"id":{"type":"string","description":"Identifier of the current task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the task details","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.CurrentTaskStatusEnum"}],"description":"Current global status of the current task","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the current task","readOnly":true}}},"common.CurrentTaskStatusEnum":{"type":"string","description":"Current status of a task. A task in ERROR cannot be retried without your inputs. PENDING tasks will be executed as soon as possible. A RUNNING task is currently executing your original request. SCHEDULED is used for tasks that will be executed in the future.","enum":["ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"common.Event":{"type":"object","description":"Represents an event for an async envelope","properties":{"createdAt":{"type":"string","description":"Creation date of the event","format":"date-time","readOnly":true},"kind":{"type":"string","description":"Nature of the event","readOnly":true},"link":{"type":"string","description":"Link to the event related resource","nullable":true,"readOnly":true},"message":{"type":"string","description":"Description of what happened on the event","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/common.EventTypeEnum"}],"description":"Type of the event","readOnly":true}}},"common.EventTypeEnum":{"type":"string","description":"Nature of an event","enum":["TARGET_SPEC_UPDATE","TASK_ERROR","TASK_START","TASK_SUCCESS"]},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"common.Task":{"type":"object","description":"Asynchronous operation","properties":{"createdAt":{"type":"string","description":"Creation date of the task","format":"date-time","readOnly":true},"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"finishedAt":{"type":"string","description":"Ending date of the task","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"string","description":"Unique identifier of the task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the related resource","readOnly":true},"message":{"type":"string","description":"Description of the task","readOnly":true},"progress":{"type":"array","description":"Progress steps of the asynchronous operation","items":{"$ref":"#/components/schemas/common.TaskProgress"},"readOnly":true},"startedAt":{"type":"string","description":"Starting date of the task","nullable":true,"format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current global status of the task","readOnly":true},"type":{"type":"string","description":"Type of the task","readOnly":true},"updatedAt":{"type":"string","description":"Last update of the task","format":"date-time","readOnly":true}}},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","readOnly":true}}},"common.TaskProgress":{"type":"object","description":"Detailed information about an asynchronous operation progress steps","properties":{"name":{"type":"string","description":"Progress step name","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current status of the progress step","readOnly":true}}},"common.TaskStatusEnum":{"type":"string","description":"Current status of a task","enum":["DONE","ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"publicCloud.lakehouse.Endpoint":{"type":"object","description":"An endpoint of a lakehouse","properties":{"component":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.EndpointComponentEnum"}],"description":"What the endpoint serves: the data console, the Apache Iceberg REST catalog, the OAuth2 token service, S3 storage or SQL","readOnly":true},"uri":{"type":"string","description":"Address of the endpoint","readOnly":true}}},"publicCloud.lakehouse.EndpointComponentEnum":{"type":"string","description":"What a lakehouse endpoint serves","enum":["DATA_CONSOLE","ICEBERG_REST","OAUTH2_TOKEN","S3","SQL"]},"publicCloud.lakehouse.IpRestriction":{"type":"object","description":"A source address or block allowed to reach a lakehouse","properties":{"description":{"type":"string","description":"Description of the entry. At most 255 characters.","nullable":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipBlock"}],"description":"A public IPv4 or IPv6 block in CIDR notation, or a single address (stored as a /32 or a /128). It is stored masked, for example 203.0.114.17/24 as 203.0.114.0/24. Private, loopback, link-local, multicast, documentation and other special-purpose ranges, and 0.0.0.0/0 and ::/0, are refused."}},"required":["ip"]},"publicCloud.lakehouse.Lakehouse":{"type":"object","description":"A lakehouse: an Apache Iceberg catalog service, its storage and its SQL compute, in one region of your project","properties":{"checksum":{"type":"string","description":"Hash of the target specification of the lakehouse. Send it back on update to make sure nobody changed the lakehouse in between.","readOnly":true},"createdAt":{"type":"string","description":"Date the lakehouse was created","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseCurrentState"}],"description":"Current state of the lakehouse, computed by the service","readOnly":true},"currentTasks":{"type":"array","description":"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.","items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the lakehouse","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"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.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseTargetSpec"}],"description":"Last requested specification of the lakehouse","readOnly":true},"updatedAt":{"type":"string","description":"Date of the last change to the lakehouse","format":"date-time","readOnly":true}}},"publicCloud.lakehouse.LakehouseCatalogCreation":{"type":"object","description":"First catalog of a lakehouse, created with it","properties":{"description":{"type":"string","description":"Description of the catalog. At most 255 characters.","nullable":true},"name":{"type":"string","description":"Name of the catalog, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation."}},"required":["name"]},"publicCloud.lakehouse.LakehouseCreation":{"type":"object","description":"Creation of a lakehouse","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseCreationTargetSpec"}],"description":"Specification of the lakehouse to create"}},"required":["targetSpec"]},"publicCloud.lakehouse.LakehouseCreationTargetSpec":{"type":"object","description":"Specification of a lakehouse to create, with its first catalog","properties":{"catalog":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseCatalogCreation"}],"description":"First catalog of the lakehouse, created with it. It then lives on as a catalog resource of its own, listed under the catalogs of the lakehouse, with its own status and tasks."},"description":{"type":"string","description":"Description of the lakehouse. At most 255 characters.","nullable":true},"ipRestrictions":{"type":"array","description":"Source addresses allowed to reach the lakehouse. When omitted, none. At most 32 entries.","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.lakehouse.IpRestriction"}},"ipRestrictionsEnabled":{"type":"boolean","description":"Whether only the addresses of `ipRestrictions` may reach the lakehouse. True needs at least one entry. Defaults to false.","nullable":true},"name":{"type":"string","description":"Name of the lakehouse, unique in the project: 3 to 63 lowercase letters, digits or underscores, starting with a letter"},"region":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RegionEnum"}],"description":"Region of the lakehouse: one of the region names listed by the lakehouse region reference. Immutable after creation."}},"required":["catalog","name","region"]},"publicCloud.lakehouse.LakehouseCurrentState":{"type":"object","description":"Current state of a lakehouse, computed by the service","properties":{"description":{"type":"string","description":"Description of the lakehouse. Null when it has none.","nullable":true,"readOnly":true},"endpoints":{"type":"array","description":"Endpoints to reach the data of the lakehouse. Empty until the lakehouse is first READY.","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.Endpoint"},"readOnly":true},"name":{"type":"string","description":"Name of the lakehouse","readOnly":true},"networkAccess":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.NetworkAccess"}],"description":"Whether the source-address allowlist of the lakehouse is enforced in its region","readOnly":true},"realm":{"type":"string","description":"Realm of the lakehouse in the Apache Iceberg REST catalog of the region. Send it in the `Polaris-Realm` header of your Iceberg client. Null until the lakehouse is first READY.","nullable":true,"readOnly":true},"region":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RegionEnum"}],"description":"Region of the lakehouse: one of the region names listed by the lakehouse region reference","readOnly":true},"statusReason":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.StatusReason"}],"description":"Why the lakehouse is in ERROR. Null in any other status.","nullable":true,"readOnly":true}}},"publicCloud.lakehouse.LakehouseTargetSpec":{"type":"object","description":"Specification of a lakehouse, as you requested it","properties":{"description":{"type":"string","description":"Description of the lakehouse. At most 255 characters.","nullable":true,"readOnly":true},"ipRestrictions":{"type":"array","description":"Source addresses allowed to reach the lakehouse, kept even while filtering is disabled. Empty when there is none.","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.IpRestriction"},"readOnly":true},"ipRestrictionsEnabled":{"type":"boolean","description":"Whether only the addresses of `ipRestrictions` may reach the lakehouse. When false, every address may.","readOnly":true},"name":{"type":"string","description":"Name of the lakehouse, unique in the project","readOnly":true},"region":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RegionEnum"}],"description":"Region of the lakehouse: one of the region names listed by the lakehouse region reference. Immutable after creation. Not part of an update.","readOnly":true}}},"publicCloud.lakehouse.LakehouseUpdate":{"type":"object","description":"Update of a lakehouse","properties":{"checksum":{"type":"string","description":"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.","nullable":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseUpdateTargetSpec"}],"description":"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."}},"required":["targetSpec"]},"publicCloud.lakehouse.LakehouseUpdateTargetSpec":{"type":"object","description":"Specification of a lakehouse that you can change after creation","properties":{"description":{"type":"string","description":"Description of the lakehouse. At most 255 characters.","nullable":true},"ipRestrictions":{"type":"array","description":"The whole list of source addresses allowed to reach the lakehouse. An empty array for none. Restate the current list to keep it: it replaces the stored one. It is kept while filtering is disabled. At most 32 entries.","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.IpRestriction"}},"ipRestrictionsEnabled":{"type":"boolean","description":"Whether only the addresses of `ipRestrictions` may reach the lakehouse. true needs at least one entry. Turning it off keeps the entries."},"name":{"type":"string","description":"New name of the lakehouse, unique in the project"}},"required":["ipRestrictions","ipRestrictionsEnabled","name"]},"publicCloud.lakehouse.NetworkAccess":{"type":"object","description":"Whether the source-address allowlist of a lakehouse is enforced in its region","properties":{"checkedAt":{"type":"string","description":"Date the region last checked the allowlist. Null when it has not reported it yet.","nullable":true,"format":"date-time","readOnly":true},"message":{"type":"string","description":"Why the allowlist is FAILED or UNSUPPORTED, for people. Null otherwise. It may change. Do not parse it.","nullable":true,"readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.NetworkAccessStateEnum"}],"description":"`DISABLED`: no filtering, every address may reach the lakehouse (filtering is off or the list is empty). `PENDING`: a change of the allowlist is being applied. `ENFORCED`: only the listed addresses may reach the lakehouse. `FAILED`: the allowlist could not be applied. `UNSUPPORTED`: the region no longer enforces allowlists. Disable or empty the list.","readOnly":true}}},"publicCloud.lakehouse.NetworkAccessStateEnum":{"type":"string","description":"Enforcement state of the source-address allowlist of a lakehouse","enum":["DISABLED","ENFORCED","FAILED","PENDING","UNSUPPORTED"]},"publicCloud.lakehouse.RegionEnum":{"type":"string","description":"Region name of a lakehouse. The lakehouse region reference lists the regions open to new lakehouses.","enum":["eu-west-par","eu-west-poc"]},"publicCloud.lakehouse.StatusReason":{"type":"object","description":"Why a resource is in ERROR","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.StatusReasonCodeEnum"}],"description":"Stable code of the reason, for programs","readOnly":true},"message":{"type":"string","description":"Explanation of the reason, for people. It may change. Do not parse it.","readOnly":true}}},"publicCloud.lakehouse.StatusReasonCodeEnum":{"type":"string","description":"Stable code of the reason why a resource is in ERROR. CATALOG_NOT_EMPTY, LAKEHOUSE_NOT_EMPTY and SCHEMA_NOT_EMPTY: a deletion was refused because data remains. Delete again with force. DEDICATED_COMPUTE_POOL_EXISTS, DEDICATED_UNAVAILABLE, INVALID_SHAPE and QUOTA_EXCEEDED: the region refused the Compute Pool shape. `RECONCILE_FAILED`: a DEDICATED engine stopped serving. `CANCELED`: OVHcloud support canceled the change. `TIMED_OUT`: the change did not complete in time. `REGION_UNAVAILABLE`: the region could not take the change. `OPERATION_FAILED`: any other failure.","enum":["CANCELED","CATALOG_NOT_EMPTY","DEDICATED_COMPUTE_POOL_EXISTS","DEDICATED_UNAVAILABLE","INVALID_SHAPE","LAKEHOUSE_NOT_EMPTY","OPERATION_FAILED","QUOTA_EXCEEDED","RECONCILE_FAILED","REGION_UNAVAILABLE","SCHEMA_NOT_EMPTY","TIMED_OUT"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/publicCloud/project/{projectId}/managedAnalytics/lakehouse":{"get":{"operationId":"getAllLakehouseServices","summary":"List the lakehouses of your project","description":"The list has no region filter: to keep the lakehouses of one region, select them on `targetSpec.region`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.Lakehouse"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@10"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudLakehouseLakehouse"},"post":{"operationId":"createLakehouseService","summary":"Create a lakehouse in your project","description":"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.\n\nThe 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.\n\nThe 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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseCreation"},"examples":{"Create a lakehouse":{"value":{"targetSpec":{"catalog":{"description":"Main catalog","name":"main"},"description":"Sales analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":true,"name":"sales","region":"eu-west-par"}},"summary":"Create a lakehouse."}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Lakehouse"},"examples":{"Lakehouse being created":{"value":{"checksum":"9c38c33d20ba4cb4b467d1dbda9e0b55","createdAt":"2026-10-01T09:00:00Z","currentState":{"description":"Sales analytics","endpoints":[],"name":"sales","networkAccess":{"checkedAt":null,"message":null,"state":"PENDING"},"realm":null,"region":"eu-west-par","statusReason":null},"currentTasks":[{"errors":[],"id":"2c8e6a4f-5d1b-4b93-8e07-9a3f6c2e4d15","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/task/2c8e6a4f-5d1b-4b93-8e07-9a3f6c2e4d15","status":"PENDING","type":"LAKEHOUSE_CREATE"}],"id":"8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30","resourceStatus":"CREATING","targetSpec":{"description":"Sales analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":true,"name":"sales","region":"eu-west-par"},"updatedAt":"2026-10-01T09:00:00Z"},"summary":"The lakehouse in CREATING, with its creation task."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidName":{"value":{"class":"Client::BadRequest::InvalidName","message":"Invalid name: use 3 to 63 lowercase letters, digits or underscores, starting with a letter"}},"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}},"Client::BadRequest::ServiceNotAvailableInRegion":{"value":{"class":"Client::BadRequest::ServiceNotAvailableInRegion","message":"This service is not available in the selected region"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::IpRestrictionsNotAvailable":{"value":{"class":"Client::Conflict::IpRestrictionsNotAvailable","message":"Source-address allowlists cannot be enabled or widened in the region of the lakehouse now; disabling or narrowing the list is always possible"}},"Client::Conflict::NameAlreadyInUse":{"value":{"class":"Client::Conflict::NameAlreadyInUse","message":"This name is already in use"}},"Client::Conflict::QuotaExceeded":{"value":{"class":"Client::Conflict::QuotaExceeded","message":"This lakehouse has reached its quota"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@30"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.lakehouse.LakehouseCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse\",\n\ttargetSpec = None, # Specification of the lakehouse to create (type: publicCloud.lakehouse.LakehouseCreationTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.lakehouse.LakehouseCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse\", array(\n\ttargetSpec => null, // Specification of the lakehouse to create (type: publicCloud.lakehouse.LakehouseCreationTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/create","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}":{"delete":{"operationId":"deleteLakehouseService","summary":"Delete a lakehouse of your project","description":"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.\n\nA 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.\n\nWithout `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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"force","description":"Also delete the tables, views and data it holds. Without it, the deletion is refused while data remains.","schema":{"type":"boolean"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Lakehouse"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::LakehouseNotEmpty":{"value":{"class":"Client::Conflict::LakehouseNotEmpty","message":"The lakehouse still holds schemas: delete them first or delete with force"}},"Client::Conflict::ResourceAlreadyBeingDeleted":{"value":{"class":"Client::Conflict::ResourceAlreadyBeingDeleted","message":"Resource is already being deleted"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@40"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/delete","required":true}]},"get":{"operationId":"getLakehouseService","summary":"Get a lakehouse of your project","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Lakehouse"},"examples":{"Lakehouse":{"value":{"checksum":"9c38c33d20ba4cb4b467d1dbda9e0b55","createdAt":"2026-10-01T09:00:00Z","currentState":{"description":"Sales analytics","endpoints":[{"component":"DATA_CONSOLE","uri":"https://console.eu-west-par.lakehouse.ovhcloud.example"},{"component":"ICEBERG_REST","uri":"https://iceberg.eu-west-par.lakehouse.ovhcloud.example/api/catalog"},{"component":"OAUTH2_TOKEN","uri":"https://iceberg.eu-west-par.lakehouse.ovhcloud.example/api/catalog/v1/oauth/tokens"},{"component":"S3","uri":"https://s3.eu-west-par.lakehouse.ovhcloud.example"},{"component":"SQL","uri":"https://sql.eu-west-par.lakehouse.ovhcloud.example"}],"name":"sales","networkAccess":{"checkedAt":"2026-10-01T09:00:35Z","message":null,"state":"ENFORCED"},"realm":"lkh-8b0f6d2e","region":"eu-west-par","statusReason":null},"currentTasks":[],"id":"8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30","resourceStatus":"READY","targetSpec":{"description":"Sales analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":true,"name":"sales","region":"eu-west-par"},"updatedAt":"2026-10-01T09:00:40Z"},"summary":"A READY lakehouse."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@20"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editLakehouseService","summary":"Update a lakehouse of your project","description":"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.\n\nThe 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.\n\nA 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.\n\nOn 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.\n\nThe 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).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.LakehouseUpdate"},"examples":{"Disable filtering":{"value":{"checksum":"9c38c33d20ba4cb4b467d1dbda9e0b55","targetSpec":{"description":"Sales analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":false,"name":"sales"}},"summary":"Turn the allowlist off. The entries are kept, ready to be enabled again."},"Update a lakehouse":{"value":{"checksum":"9c38c33d20ba4cb4b467d1dbda9e0b55","targetSpec":{"description":"Sales and marketing analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":true,"name":"sales"}},"summary":"Change the description of the lakehouse. The body is the complete target specification that you can change."}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Lakehouse"},"examples":{"Lakehouse updated":{"value":{"checksum":"f4c4b2382bcf4581fe634dd3f9373a6d","createdAt":"2026-10-01T09:00:00Z","currentState":{"description":"Sales and marketing analytics","endpoints":[{"component":"DATA_CONSOLE","uri":"https://console.eu-west-par.lakehouse.ovhcloud.example"},{"component":"ICEBERG_REST","uri":"https://iceberg.eu-west-par.lakehouse.ovhcloud.example/api/catalog"},{"component":"OAUTH2_TOKEN","uri":"https://iceberg.eu-west-par.lakehouse.ovhcloud.example/api/catalog/v1/oauth/tokens"},{"component":"S3","uri":"https://s3.eu-west-par.lakehouse.ovhcloud.example"},{"component":"SQL","uri":"https://sql.eu-west-par.lakehouse.ovhcloud.example"}],"name":"sales","networkAccess":{"checkedAt":"2026-10-01T09:00:35Z","message":null,"state":"ENFORCED"},"realm":"lkh-8b0f6d2e","region":"eu-west-par","statusReason":null},"currentTasks":[],"id":"8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30","resourceStatus":"READY","targetSpec":{"description":"Sales and marketing analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":true,"name":"sales","region":"eu-west-par"},"updatedAt":"2026-10-01T10:00:00Z"},"summary":"The lakehouse READY, with the change applied at once."},"Lakehouse updating":{"value":{"checksum":"52087a6c9db2562228f0ab1e733a3981","createdAt":"2026-10-01T09:00:00Z","currentState":{"description":"Sales analytics","endpoints":[{"component":"DATA_CONSOLE","uri":"https://console.eu-west-par.lakehouse.ovhcloud.example"},{"component":"ICEBERG_REST","uri":"https://iceberg.eu-west-par.lakehouse.ovhcloud.example/api/catalog"},{"component":"OAUTH2_TOKEN","uri":"https://iceberg.eu-west-par.lakehouse.ovhcloud.example/api/catalog/v1/oauth/tokens"},{"component":"S3","uri":"https://s3.eu-west-par.lakehouse.ovhcloud.example"},{"component":"SQL","uri":"https://sql.eu-west-par.lakehouse.ovhcloud.example"}],"name":"sales","networkAccess":{"checkedAt":"2026-10-01T09:00:35Z","message":null,"state":"PENDING"},"realm":"lkh-8b0f6d2e","region":"eu-west-par","statusReason":null},"currentTasks":[{"errors":[],"id":"6d1e9b2a-4c7f-4a38-b5e0-3f8a2c9d7e14","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/task/6d1e9b2a-4c7f-4a38-b5e0-3f8a2c9d7e14","status":"PENDING","type":"LAKEHOUSE_UPDATE"}],"id":"8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30","resourceStatus":"UPDATING","targetSpec":{"description":"Sales analytics","ipRestrictions":[{"description":"Head office","ip":"51.68.10.0/24"}],"ipRestrictionsEnabled":false,"name":"sales","region":"eu-west-par"},"updatedAt":"2026-10-01T11:00:00Z"},"summary":"The lakehouse UPDATING after filtering was turned off: the region removes the allowlist, then the lakehouse is READY with networkAccess DISABLED."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidName":{"value":{"class":"Client::BadRequest::InvalidName","message":"Invalid name: use 3 to 63 lowercase letters, digits or underscores, starting with a letter"}},"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ChecksumMismatch":{"value":{"class":"Client::Conflict::ChecksumMismatch","message":"Checksum mismatch — a concurrent update was detected. Refresh the resource and retry"}},"Client::Conflict::IpRestrictionsNotAvailable":{"value":{"class":"Client::Conflict::IpRestrictionsNotAvailable","message":"Source-address allowlists cannot be enabled or widened in the region of the lakehouse now; disabling or narrowing the list is always possible"}},"Client::Conflict::NameAlreadyInUse":{"value":{"class":"Client::Conflict::NameAlreadyInUse","message":"This name is already in use"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@50"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.lakehouse.LakehouseUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}\",\n\tchecksum = None, # 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. (type: string, nullable)\n\ttargetSpec = None, # 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. (type: publicCloud.lakehouse.LakehouseUpdateTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.lakehouse.LakehouseUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}\", array(\n\tchecksum => null, // 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. (type: string, nullable)\n\ttargetSpec => null, // 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. (type: publicCloud.lakehouse.LakehouseUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/edit","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/event":{"get":{"operationId":"getLakehouseEvents","summary":"List the events of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"query","name":"taskId","description":"Return only the events of this task","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Event"}},"examples":{"Creation history":{"value":[{"createdAt":"2026-10-01T09:00:40Z","kind":"LAKEHOUSE_CREATE","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/task/2c8e6a4f-5d1b-4b93-8e07-9a3f6c2e4d15","message":"Task completed","type":"TASK_SUCCESS"},{"createdAt":"2026-10-01T09:00:05Z","kind":"LAKEHOUSE_CREATE","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/task/2c8e6a4f-5d1b-4b93-8e07-9a3f6c2e4d15","message":"Task started","type":"TASK_START"},{"createdAt":"2026-10-01T09:00:00Z","kind":"LAKEHOUSE_CREATE","link":null,"message":"Target specification updated","type":"TARGET_SPEC_UPDATE"}],"summary":"The events of a creation that completed."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@60"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/event\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/event\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/event/get","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task":{"get":{"operationId":"getAllLakehouseTasks","summary":"List the tasks of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Task"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@70"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/task/get","required":true}],"x-response-identifier":"id","x-expanded-response":"CommonTask"}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task/{taskId}":{"get":{"operationId":"getLakehouseTask","summary":"Get a task of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common.Task"},"examples":{"Completed task":{"value":{"createdAt":"2026-10-01T09:00:00Z","errors":[],"finishedAt":"2026-10-01T09:00:40Z","id":"2c8e6a4f-5d1b-4b93-8e07-9a3f6c2e4d15","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/task/2c8e6a4f-5d1b-4b93-8e07-9a3f6c2e4d15","message":"Change applied","progress":[{"name":"Provision the resource","status":"DONE"}],"startedAt":"2026-10-01T09:00:05Z","status":"DONE","type":"LAKEHOUSE_CREATE","updatedAt":"2026-10-01T09:00:40Z"},"summary":"A creation task that completed."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::TaskDoesNotExist":{"value":{"class":"Client::NotFound::TaskDoesNotExist","message":"Task not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse@@@80"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/task/get","required":true}],"x-response-identifier":"id"}}},"tags":[{"name":"Managed Analytics","x-tag-expanded":false,"description":"Missing description"},{"name":"Lakehouse","x-tag-expanded":false,"description":"Missing description"}]}
