# Public Cloud › Analytics › Lakehouse › Catalogs API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Public Cloud product's sections: https://developers.eu.ovhcloud.com/reference/public-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 15 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/

OpenAPI v1: https://api.eu.ovhcloud.com/v1/__schemas/developer-hub-navigation/public-cloud/analytics/lakehouse/catalogs.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/public-cloud/analytics/lakehouse/catalogs.json?format=openapi3

## Operations

- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog` — List the catalogs of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}` — Get a catalog of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog` — Create a catalog in your lakehouse
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}` — Delete a catalog of your lakehouse
- `PUT /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}` — Update a catalog of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task` — List the tasks of a catalog of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task/{taskId}` — Get a task of a catalog of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/event` — List the events of a catalog of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema` — List the schemas of a catalog of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}` — Get a schema of a catalog of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema` — Create a schema in a catalog of your lakehouse
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}` — Delete a schema of a catalog of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event` — List the events of a schema of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task` — List the tasks of a schema of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId}` — Get a task of a schema of your lakehouse

## List the catalogs of your lakehouse

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

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getAllLakehouseCatalogs

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Catalog[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between. |
| `createdAt` | string (date-time) | read-only | Date the catalog was created |
| `currentState` | publicCloud.lakehouse.CatalogCurrentState | read-only | Current state of the catalog, computed by the service |
| `currentState.description` | string | read-only | Description of the catalog. Null when it has none. |
| `currentState.name` | string | read-only | Name of the catalog |
| `currentState.sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>`. Null until the catalog is first READY. |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the catalog is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.warehouse` | string | read-only | Warehouse name of the catalog, the value your Apache Iceberg REST client sends as its warehouse. Null until the catalog is first READY. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the catalog |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the catalog. 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. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CatalogTargetSpec | read-only | Last requested specification of the catalog |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the catalog, unique in the lakehouse, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation. Not part of an update. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the catalog |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "currentState": {
      "description": "string",
      "name": "string",
      "sqlCatalog": "string",
      "statusReason": {
        "code": "CANCELED",
        "message": "string"
      },
      "warehouse": "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",
      "name": "string"
    },
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog");

print_r($result);
?>
```

## Get a catalog of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getLakehouseCatalog

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Catalog | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between. |
| `createdAt` | string (date-time) | read-only | Date the catalog was created |
| `currentState` | publicCloud.lakehouse.CatalogCurrentState | read-only | Current state of the catalog, computed by the service |
| `currentState.description` | string | read-only | Description of the catalog. Null when it has none. |
| `currentState.name` | string | read-only | Name of the catalog |
| `currentState.sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>`. Null until the catalog is first READY. |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the catalog is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.warehouse` | string | read-only | Warehouse name of the catalog, the value your Apache Iceberg REST client sends as its warehouse. Null until the catalog is first READY. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the catalog |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the catalog. 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. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CatalogTargetSpec | read-only | Last requested specification of the catalog |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the catalog, unique in the lakehouse, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation. Not part of an update. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the catalog |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "description": "string",
    "name": "string",
    "sqlCatalog": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "warehouse": "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",
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}");

print_r($result);
?>
```

## Create a catalog in your lakehouse

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#createLakehouseCatalog

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/create`

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

The creation is refused with a 409 while the lakehouse is being deleted.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Request body (required)

Type: `publicCloud.lakehouse.CatalogCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetSpec` | publicCloud.lakehouse.CatalogTargetSpec | yes | Specification of the catalog to create |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the catalog, unique in the lakehouse, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation. Not part of an update. |

```json
{
  "targetSpec": {
    "description": "string",
    "name": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Catalog | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between. |
| `createdAt` | string (date-time) | read-only | Date the catalog was created |
| `currentState` | publicCloud.lakehouse.CatalogCurrentState | read-only | Current state of the catalog, computed by the service |
| `currentState.description` | string | read-only | Description of the catalog. Null when it has none. |
| `currentState.name` | string | read-only | Name of the catalog |
| `currentState.sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>`. Null until the catalog is first READY. |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the catalog is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.warehouse` | string | read-only | Warehouse name of the catalog, the value your Apache Iceberg REST client sends as its warehouse. Null until the catalog is first READY. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the catalog |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the catalog. 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. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CatalogTargetSpec | read-only | Last requested specification of the catalog |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the catalog, unique in the lakehouse, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation. Not part of an update. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the catalog |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "description": "string",
    "name": "string",
    "sqlCatalog": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "warehouse": "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",
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.lakehouse.CatalogCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog",
	targetSpec = None, # Specification of the catalog to create (type: publicCloud.lakehouse.CatalogTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.lakehouse.CatalogCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog", array(
	targetSpec => null, // Specification of the catalog to create (type: publicCloud.lakehouse.CatalogTargetSpec)
));

print_r($result);
?>
```

## Delete a catalog of your lakehouse

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#deleteLakehouseCatalog

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/delete`

Deletes the catalog asynchronously. The response is the catalog in DELETING, with the deletion task in `currentTasks`. Once the deletion completes, the catalog and every route under it, its tasks included, answer 404. Deleting a catalog also deletes its schemas, and the role assignments scoped to the catalog. A role permission that targets the catalog or one of its schemas is kept, with the `targetState` TARGET_DELETED, and gives nothing.

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 catalog still holds data. The refusal shows asynchronously as the catalog in ERROR, with the status reason code `CATALOG_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 catalog holds are deleted too.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `force` | query | boolean |  | Also delete the tables, views and data it holds. Without it, the deletion is refused while data remains. |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Catalog | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between. |
| `createdAt` | string (date-time) | read-only | Date the catalog was created |
| `currentState` | publicCloud.lakehouse.CatalogCurrentState | read-only | Current state of the catalog, computed by the service |
| `currentState.description` | string | read-only | Description of the catalog. Null when it has none. |
| `currentState.name` | string | read-only | Name of the catalog |
| `currentState.sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>`. Null until the catalog is first READY. |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the catalog is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.warehouse` | string | read-only | Warehouse name of the catalog, the value your Apache Iceberg REST client sends as its warehouse. Null until the catalog is first READY. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the catalog |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the catalog. 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. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CatalogTargetSpec | read-only | Last requested specification of the catalog |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the catalog, unique in the lakehouse, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation. Not part of an update. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the catalog |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "description": "string",
    "name": "string",
    "sqlCatalog": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "warehouse": "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",
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}");

print_r($result);
?>
```

## Update a catalog of your lakehouse

`PUT /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#editLakehouseCatalog

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/edit`

Replaces the catalog's target specification as a whole. The body carries the complete desired state of every field `publicCloud.lakehouse.CatalogUpdateTargetSpec` exposes — `description` — so read the catalog first and restate every value you want to keep: a field left out of `targetSpec` is cleared, not carried over from the stored specification.

The create-only field `name` cannot be changed once the catalog exists. It is deliberately absent from the update model, and sending it is rejected with a 400.

On a READY catalog the change is applied at once: the response is 200 with the catalog READY. On a catalog in ERROR the change is applied asynchronously, even when the specification is unchanged, to bring the catalog out of ERROR: the response is 202 with the catalog UPDATING and the new task in `currentTasks`. The update is refused with a 409 while the catalog 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 catalog'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).

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Request body (required)

Type: `publicCloud.lakehouse.CatalogUpdate`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string |  | Checksum of the catalog as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the catalog changed since. When omitted or empty, no check is made. |
| `targetSpec` | publicCloud.lakehouse.CatalogUpdateTargetSpec | yes | New specification of the catalog. 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. |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |

```json
{
  "checksum": "string",
  "targetSpec": {
    "description": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Catalog | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the catalog. Send it back on update to make sure nobody changed the catalog in between. |
| `createdAt` | string (date-time) | read-only | Date the catalog was created |
| `currentState` | publicCloud.lakehouse.CatalogCurrentState | read-only | Current state of the catalog, computed by the service |
| `currentState.description` | string | read-only | Description of the catalog. Null when it has none. |
| `currentState.name` | string | read-only | Name of the catalog |
| `currentState.sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>`. Null until the catalog is first READY. |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the catalog is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.warehouse` | string | read-only | Warehouse name of the catalog, the value your Apache Iceberg REST client sends as its warehouse. Null until the catalog is first READY. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the catalog, and its last failed task while the catalog is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the catalog |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the catalog. 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. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CatalogTargetSpec | read-only | Last requested specification of the catalog |
| `targetSpec.description` | string |  | Description of the catalog. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the catalog, unique in the lakehouse, the name Apache Iceberg and SQL clients see. Same rules as the lakehouse name. Immutable after creation. Not part of an update. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the catalog |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "description": "string",
    "name": "string",
    "sqlCatalog": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "warehouse": "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",
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.lakehouse.CatalogUpdate
result = client.put("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}",
	checksum = None, # Checksum of the catalog as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the catalog changed since. When omitted or empty, no check is made. (type: string, nullable)
	targetSpec = None, # New specification of the catalog. 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.CatalogUpdateTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.lakehouse.CatalogUpdate
$result = $ovh->put("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}", array(
	checksum => null, // Checksum of the catalog as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the catalog changed since. When omitted or empty, no check is made. (type: string, nullable)
	targetSpec => null, // New specification of the catalog. 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.CatalogUpdateTargetSpec)
));

print_r($result);
?>
```

## List the tasks of a catalog of your lakehouse

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

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getAllLakehouseCatalogTasks

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/task/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Task[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the task |
| `errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `errors[].message` | string | read-only | Error description |
| `finishedAt` | string (date-time) | read-only | Ending date of the task |
| `id` | string (uuid) | read-only | Unique identifier of the task |
| `link` | string | read-only | Link to the related resource |
| `message` | string | read-only | Description of the task |
| `progress` | common.TaskProgress[] | read-only | Progress steps of the asynchronous operation |
| `progress[].name` | string | read-only | Progress step name |
| `progress[].status` | common.TaskStatusEnum | read-only | Current status of the progress step — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `startedAt` | string (date-time) | read-only | Starting date of the task |
| `status` | common.TaskStatusEnum | read-only | Current global status of the task — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `type` | string | read-only | Type of the task |
| `updatedAt` | string (date-time) | read-only | Last update of the task |

```json
[
  {
    "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"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task");

print_r($result);
?>
```

## Get a task of a catalog of your lakehouse

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

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getLakehouseCatalogTask

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/task/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `taskId` | path | string (uuid) | yes | Task ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Task | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the task |
| `errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `errors[].message` | string | read-only | Error description |
| `finishedAt` | string (date-time) | read-only | Ending date of the task |
| `id` | string (uuid) | read-only | Unique identifier of the task |
| `link` | string | read-only | Link to the related resource |
| `message` | string | read-only | Description of the task |
| `progress` | common.TaskProgress[] | read-only | Progress steps of the asynchronous operation |
| `progress[].name` | string | read-only | Progress step name |
| `progress[].status` | common.TaskStatusEnum | read-only | Current status of the progress step — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `startedAt` | string (date-time) | read-only | Starting date of the task |
| `status` | common.TaskStatusEnum | read-only | Current global status of the task — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `type` | string | read-only | Type of the task |
| `updatedAt` | string (date-time) | read-only | Last update of the task |

```json
{
  "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"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task/{taskId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task/{taskId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/task/{taskId}");

print_r($result);
?>
```

## List the events of a catalog of your lakehouse

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

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getLakehouseCatalogEvents

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/event/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `taskId` | query | string (uuid) |  | Return only the events of this task |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Event[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the event |
| `kind` | string | read-only | Nature of the event |
| `link` | string | read-only | Link to the event related resource |
| `message` | string | read-only | Description of what happened on the event |
| `type` | common.EventTypeEnum | read-only | Type of the event — one of `TARGET_SPEC_UPDATE`, `TASK_ERROR`, `TASK_START`, `TASK_SUCCESS` |

```json
[
  {
    "createdAt": "2024-01-01T12:00:00Z",
    "kind": "string",
    "link": "string",
    "message": "string",
    "type": "TARGET_SPEC_UPDATE"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/event" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/event")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/event");

print_r($result);
?>
```

## List the schemas of a catalog of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getAllLakehouseCatalogSchemas

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Schema[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the schema, which never changes after creation |
| `createdAt` | string (date-time) | read-only | Date the schema was created |
| `currentState` | publicCloud.lakehouse.SchemaCurrentState | read-only | Current state of the schema, computed by the service |
| `currentState.name` | string | read-only | Name of the schema |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the schema is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the schema |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.SchemaTargetSpec | read-only | Last requested specification of the schema |
| `targetSpec.name` | string | yes | Name of the schema, unique in its catalog. Same rules as the lakehouse name. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the schema |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "currentState": {
      "name": "string",
      "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": {
      "name": "string"
    },
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema");

print_r($result);
?>
```

## Get a schema of a catalog of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getLakehouseCatalogSchema

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `schemaId` | path | string (uuid) | yes | Schema ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Schema | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the schema, which never changes after creation |
| `createdAt` | string (date-time) | read-only | Date the schema was created |
| `currentState` | publicCloud.lakehouse.SchemaCurrentState | read-only | Current state of the schema, computed by the service |
| `currentState.name` | string | read-only | Name of the schema |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the schema is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the schema |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.SchemaTargetSpec | read-only | Last requested specification of the schema |
| `targetSpec.name` | string | yes | Name of the schema, unique in its catalog. Same rules as the lakehouse name. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the schema |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "name": "string",
    "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": {
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}");

print_r($result);
?>
```

## Create a schema in a catalog of your lakehouse

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#createLakehouseCatalogSchema

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/create`

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

The creation is refused with a 409 while the lakehouse or the catalog is being deleted. A schema cannot be changed after creation.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Request body (required)

Type: `publicCloud.lakehouse.SchemaCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetSpec` | publicCloud.lakehouse.SchemaTargetSpec | yes | Specification of the schema to create |
| `targetSpec.name` | string | yes | Name of the schema, unique in its catalog. Same rules as the lakehouse name. Immutable after creation. |

```json
{
  "targetSpec": {
    "name": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Schema | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the schema, which never changes after creation |
| `createdAt` | string (date-time) | read-only | Date the schema was created |
| `currentState` | publicCloud.lakehouse.SchemaCurrentState | read-only | Current state of the schema, computed by the service |
| `currentState.name` | string | read-only | Name of the schema |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the schema is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the schema |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.SchemaTargetSpec | read-only | Last requested specification of the schema |
| `targetSpec.name` | string | yes | Name of the schema, unique in its catalog. Same rules as the lakehouse name. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the schema |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "name": "string",
    "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": {
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.lakehouse.SchemaCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema",
	targetSpec = None, # Specification of the schema to create (type: publicCloud.lakehouse.SchemaTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.lakehouse.SchemaCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema", array(
	targetSpec => null, // Specification of the schema to create (type: publicCloud.lakehouse.SchemaTargetSpec)
));

print_r($result);
?>
```

## Delete a schema of a catalog of your lakehouse

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#deleteLakehouseCatalogSchema

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/delete`

Deletes the schema asynchronously. The response is the schema in DELETING, with the deletion task in `currentTasks`. Once the deletion completes, the schema and every route under it, its tasks included, answer 404. A role permission that targets the schema is kept, with the `targetState` TARGET_DELETED, and gives nothing.

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 schema still holds data. The refusal shows asynchronously as the schema in ERROR, with the status reason code `SCHEMA_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 schema holds are deleted too.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `force` | query | boolean |  | Also delete the tables, views and data it holds. Without it, the deletion is refused while data remains. |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `schemaId` | path | string (uuid) | yes | Schema ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Schema | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the schema, which never changes after creation |
| `createdAt` | string (date-time) | read-only | Date the schema was created |
| `currentState` | publicCloud.lakehouse.SchemaCurrentState | read-only | Current state of the schema, computed by the service |
| `currentState.name` | string | read-only | Name of the schema |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the schema is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `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` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the schema, and its last failed task while the schema is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the schema |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the schema. The schema cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR, CREATING and UPDATING, and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.SchemaTargetSpec | read-only | Last requested specification of the schema |
| `targetSpec.name` | string | yes | Name of the schema, unique in its catalog. Same rules as the lakehouse name. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the schema |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "name": "string",
    "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": {
    "name": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}");

print_r($result);
?>
```

## List the events of a schema of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getLakehouseCatalogSchemaEvents

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/event/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `schemaId` | path | string (uuid) | yes | Schema ID |
| `taskId` | query | string (uuid) |  | Return only the events of this task |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Event[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the event |
| `kind` | string | read-only | Nature of the event |
| `link` | string | read-only | Link to the event related resource |
| `message` | string | read-only | Description of what happened on the event |
| `type` | common.EventTypeEnum | read-only | Type of the event — one of `TARGET_SPEC_UPDATE`, `TASK_ERROR`, `TASK_START`, `TASK_SUCCESS` |

```json
[
  {
    "createdAt": "2024-01-01T12:00:00Z",
    "kind": "string",
    "link": "string",
    "message": "string",
    "type": "TARGET_SPEC_UPDATE"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/event");

print_r($result);
?>
```

## List the tasks of a schema of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getAllLakehouseCatalogSchemaTasks

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/task/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `schemaId` | path | string (uuid) | yes | Schema ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Task[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the task |
| `errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `errors[].message` | string | read-only | Error description |
| `finishedAt` | string (date-time) | read-only | Ending date of the task |
| `id` | string (uuid) | read-only | Unique identifier of the task |
| `link` | string | read-only | Link to the related resource |
| `message` | string | read-only | Description of the task |
| `progress` | common.TaskProgress[] | read-only | Progress steps of the asynchronous operation |
| `progress[].name` | string | read-only | Progress step name |
| `progress[].status` | common.TaskStatusEnum | read-only | Current status of the progress step — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `startedAt` | string (date-time) | read-only | Starting date of the task |
| `status` | common.TaskStatusEnum | read-only | Current global status of the task — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `type` | string | read-only | Type of the task |
| `updatedAt` | string (date-time) | read-only | Last update of the task |

```json
[
  {
    "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"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task");

print_r($result);
?>
```

## Get a task of a schema of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/catalogs/#getLakehouseCatalogSchemaTask

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/catalog/schema/task/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `catalogId` | path | string (uuid) | yes | Catalog ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `schemaId` | path | string (uuid) | yes | Schema ID |
| `taskId` | path | string (uuid) | yes | Task ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Task | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the task |
| `errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `errors[].message` | string | read-only | Error description |
| `finishedAt` | string (date-time) | read-only | Ending date of the task |
| `id` | string (uuid) | read-only | Unique identifier of the task |
| `link` | string | read-only | Link to the related resource |
| `message` | string | read-only | Description of the task |
| `progress` | common.TaskProgress[] | read-only | Progress steps of the asynchronous operation |
| `progress[].name` | string | read-only | Progress step name |
| `progress[].status` | common.TaskStatusEnum | read-only | Current status of the progress step — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `startedAt` | string (date-time) | read-only | Starting date of the task |
| `status` | common.TaskStatusEnum | read-only | Current global status of the task — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `type` | string | read-only | Type of the task |
| `updatedAt` | string (date-time) | read-only | Last update of the task |

```json
{
  "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"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/catalog/{catalogId}/schema/{schemaId}/task/{taskId}");

print_r($result);
?>
```
