# Public Cloud › Analytics › Lakehouse › Tags 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

> 8 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/tags/

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

## Operations

- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag` — List the tags of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}` — Get a tag of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag` — Create a custom tag in your lakehouse
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}` — Delete a custom tag of your lakehouse
- `PUT /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}` — Update a tag of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}/task` — List the tasks of a tag of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}/task/{taskId}` — Get a task of a tag of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}/event` — List the events of a tag of your lakehouse

## List the tags of your lakehouse

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

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

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

Lists the four predefined tags first, then the custom tags. Every lakehouse holds the four predefined tags from its creation: `pii` (personal data, by category), `sensitivity` (`low`, `medium` or `high`), `deprecated` (no value) and `domain` (any value). Their key and the objects they apply to cannot be changed, they cannot be deleted, and they are not counted in the tag quota. Their description and values can be changed.

The tag definitions are the vocabulary of the lakehouse, shared by its catalogs. A tag is applied to a table, a view or a column from the data console, by a user allowed to change that object, and is stored in its Apache Iceberg metadata. This API manages the definitions only: it never knows which objects carry a tag.

### 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.Tag[] | 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 tag. Send it back on update to make sure nobody changed the tag in between. |
| `createdAt` | string (date-time) | read-only | Date the tag was created |
| `currentState` | publicCloud.lakehouse.TagCurrentState | read-only | Current state of the tag, computed by the service |
| `currentState.allowedValues` | string[] | read-only | Values the tag accepts. Empty when the tag accepts any value or none. |
| `currentState.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | read-only | Kinds of object the tag can be applied to |
| `currentState.description` | string | read-only | Description of the tag. Null when it has none. |
| `currentState.key` | string | read-only | Key of the tag |
| `currentState.kind` | publicCloud.lakehouse.TagKindEnum | read-only | Whether the tag is predefined or custom — one of `CUSTOM`, `PREDEFINED` |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the tag 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 tag, and its last failed task while the tag 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 tag |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the tag. A change is accepted only in READY or ERROR. 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.TagTargetSpec | read-only | Last requested specification of the tag |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique. A value follows the rules of the key, and the key, a colon and the value are at most 63 characters together. An empty list lets the tag be applied with any value or with none. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted when the tag has none. At most 2000 characters. |
| `targetSpec.key` | string | yes | Key of the tag, unique in the lakehouse: 1 to 63 lowercase letters, digits, underscores, dots or hyphens, starting with a letter or a digit. The keys of the predefined tags (`pii`, `sensitivity`, `deprecated`, `domain`) are reserved. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the tag |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "currentState": {
      "allowedValues": [
        "string"
      ],
      "appliesTo": [
        "COLUMN"
      ],
      "description": "string",
      "key": "string",
      "kind": "CUSTOM",
      "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": {
      "allowedValues": [
        "string"
      ],
      "appliesTo": [
        "COLUMN"
      ],
      "description": "string",
      "key": "string"
    },
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag" \
  -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}/tag")

# 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}/tag");

print_r($result);
?>
```

## Get a tag of your lakehouse

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

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

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

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Tag | 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 tag. Send it back on update to make sure nobody changed the tag in between. |
| `createdAt` | string (date-time) | read-only | Date the tag was created |
| `currentState` | publicCloud.lakehouse.TagCurrentState | read-only | Current state of the tag, computed by the service |
| `currentState.allowedValues` | string[] | read-only | Values the tag accepts. Empty when the tag accepts any value or none. |
| `currentState.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | read-only | Kinds of object the tag can be applied to |
| `currentState.description` | string | read-only | Description of the tag. Null when it has none. |
| `currentState.key` | string | read-only | Key of the tag |
| `currentState.kind` | publicCloud.lakehouse.TagKindEnum | read-only | Whether the tag is predefined or custom — one of `CUSTOM`, `PREDEFINED` |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the tag 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 tag, and its last failed task while the tag 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 tag |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the tag. A change is accepted only in READY or ERROR. 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.TagTargetSpec | read-only | Last requested specification of the tag |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique. A value follows the rules of the key, and the key, a colon and the value are at most 63 characters together. An empty list lets the tag be applied with any value or with none. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted when the tag has none. At most 2000 characters. |
| `targetSpec.key` | string | yes | Key of the tag, unique in the lakehouse: 1 to 63 lowercase letters, digits, underscores, dots or hyphens, starting with a letter or a digit. The keys of the predefined tags (`pii`, `sensitivity`, `deprecated`, `domain`) are reserved. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the tag |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string",
    "kind": "CUSTOM",
    "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": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}" \
  -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}/tag/{tagId}")

# 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}/tag/{tagId}");

print_r($result);
?>
```

## Create a custom tag in your lakehouse

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

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

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

Creates the custom tag asynchronously. The response is the tag in CREATING, with the creation task in `currentTasks`: follow it on the task routes of the tag, or read the tag until its `resourceStatus` is READY or ERROR. Once READY, the tag can be applied from the data console to the kinds of object listed in `appliesTo`.

The key is unique among the tags of the lakehouse: another tag with the same key is refused with a 409. The keys of the predefined tags are reserved: the creation is refused with a 409 that says so. With `allowedValues`, the tag can be applied only with one of them. With an empty list, with any value or with none. A lakehouse holds at most 50 custom tags.

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.TagCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetSpec` | publicCloud.lakehouse.TagTargetSpec | yes | Specification of the tag to create |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique. A value follows the rules of the key, and the key, a colon and the value are at most 63 characters together. An empty list lets the tag be applied with any value or with none. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted when the tag has none. At most 2000 characters. |
| `targetSpec.key` | string | yes | Key of the tag, unique in the lakehouse: 1 to 63 lowercase letters, digits, underscores, dots or hyphens, starting with a letter or a digit. The keys of the predefined tags (`pii`, `sensitivity`, `deprecated`, `domain`) are reserved. Immutable after creation. |

```json
{
  "targetSpec": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Tag | 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 tag. Send it back on update to make sure nobody changed the tag in between. |
| `createdAt` | string (date-time) | read-only | Date the tag was created |
| `currentState` | publicCloud.lakehouse.TagCurrentState | read-only | Current state of the tag, computed by the service |
| `currentState.allowedValues` | string[] | read-only | Values the tag accepts. Empty when the tag accepts any value or none. |
| `currentState.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | read-only | Kinds of object the tag can be applied to |
| `currentState.description` | string | read-only | Description of the tag. Null when it has none. |
| `currentState.key` | string | read-only | Key of the tag |
| `currentState.kind` | publicCloud.lakehouse.TagKindEnum | read-only | Whether the tag is predefined or custom — one of `CUSTOM`, `PREDEFINED` |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the tag 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 tag, and its last failed task while the tag 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 tag |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the tag. A change is accepted only in READY or ERROR. 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.TagTargetSpec | read-only | Last requested specification of the tag |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique. A value follows the rules of the key, and the key, a colon and the value are at most 63 characters together. An empty list lets the tag be applied with any value or with none. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted when the tag has none. At most 2000 characters. |
| `targetSpec.key` | string | yes | Key of the tag, unique in the lakehouse: 1 to 63 lowercase letters, digits, underscores, dots or hyphens, starting with a letter or a digit. The keys of the predefined tags (`pii`, `sensitivity`, `deprecated`, `domain`) are reserved. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the tag |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string",
    "kind": "CUSTOM",
    "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": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag" \
  -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.TagCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag",
	targetSpec = None, # Specification of the tag to create (type: publicCloud.lakehouse.TagTargetSpec)
)

# 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.TagCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag", array(
	targetSpec => null, // Specification of the tag to create (type: publicCloud.lakehouse.TagTargetSpec)
));

print_r($result);
?>
```

## Delete a custom tag of your lakehouse

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}`

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

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

Deletes the custom tag asynchronously. The response is the tag in DELETING, with the deletion task in `currentTasks`. Once the deletion completes, the tag and every route under it, its tasks included, answer 404.

A tag can be deleted while tables, views or columns carry it. They are not changed: the tag stays in their Apache Iceberg metadata and the data console shows it as an unmanaged tag, which can be removed but not applied again. The data console shows how many objects carry a tag before you delete it.

A predefined tag cannot be deleted: the deletion is refused with a 409.

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.

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Tag | 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 tag. Send it back on update to make sure nobody changed the tag in between. |
| `createdAt` | string (date-time) | read-only | Date the tag was created |
| `currentState` | publicCloud.lakehouse.TagCurrentState | read-only | Current state of the tag, computed by the service |
| `currentState.allowedValues` | string[] | read-only | Values the tag accepts. Empty when the tag accepts any value or none. |
| `currentState.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | read-only | Kinds of object the tag can be applied to |
| `currentState.description` | string | read-only | Description of the tag. Null when it has none. |
| `currentState.key` | string | read-only | Key of the tag |
| `currentState.kind` | publicCloud.lakehouse.TagKindEnum | read-only | Whether the tag is predefined or custom — one of `CUSTOM`, `PREDEFINED` |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the tag 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 tag, and its last failed task while the tag 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 tag |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the tag. A change is accepted only in READY or ERROR. 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.TagTargetSpec | read-only | Last requested specification of the tag |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique. A value follows the rules of the key, and the key, a colon and the value are at most 63 characters together. An empty list lets the tag be applied with any value or with none. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted when the tag has none. At most 2000 characters. |
| `targetSpec.key` | string | yes | Key of the tag, unique in the lakehouse: 1 to 63 lowercase letters, digits, underscores, dots or hyphens, starting with a letter or a digit. The keys of the predefined tags (`pii`, `sensitivity`, `deprecated`, `domain`) are reserved. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the tag |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string",
    "kind": "CUSTOM",
    "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": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}" \
  -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}/tag/{tagId}")

# 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}/tag/{tagId}");

print_r($result);
?>
```

## Update a tag of your lakehouse

`PUT /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}`

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

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

Replaces the tag's target specification as a whole. The body carries the complete desired state of every field `publicCloud.lakehouse.TagUpdateTargetSpec` exposes — `description`, `allowedValues` and `appliesTo` — so read the tag first and restate every value you want to keep: a field left out of `targetSpec` is cleared, and `allowedValues` and `appliesTo` replace the whole lists, they are not merged with them.

The create-only field `key` cannot be changed once the tag exists. It is deliberately absent from the update model, and sending it is rejected with a 400. On a predefined tag, the description and the values can be changed but `appliesTo` cannot: a different list is rejected with a 400.

Removing a value, or a kind of object from `appliesTo`, does not change the objects that carry the tag: the data console shows it on them as an unmanaged tag.

The change is applied asynchronously: the response is 202 with the tag UPDATING and the new task in `currentTasks`. The update is refused with a 409 while the tag is CREATING, UPDATING or DELETING.

The optional `checksum` guards against a lost update: when supplied it must match the tag'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 |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `tagId` | path | string (uuid) | yes | Tag ID |

### Request body (required)

Type: `publicCloud.lakehouse.TagUpdate`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string |  | Checksum of the tag as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the tag changed since. When omitted or empty, no check is made. |
| `targetSpec` | publicCloud.lakehouse.TagUpdateTargetSpec | yes | New specification of the tag. It replaces the whole current specification: an optional field you omit is reset to its default, and `allowedValues` and `appliesTo` replace the whole lists. Send only the fields of this model: a field that can only be set at creation is refused. |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique, with the rules of the creation. An empty list lets the tag be applied with any value or with none. The objects that carry a value you remove keep it, and it is shown as an unmanaged tag on them. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once. On a predefined tag it cannot be changed: send it back unchanged. |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted to remove the description. At most 2000 characters. |

```json
{
  "checksum": "string",
  "targetSpec": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Tag | 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 tag. Send it back on update to make sure nobody changed the tag in between. |
| `createdAt` | string (date-time) | read-only | Date the tag was created |
| `currentState` | publicCloud.lakehouse.TagCurrentState | read-only | Current state of the tag, computed by the service |
| `currentState.allowedValues` | string[] | read-only | Values the tag accepts. Empty when the tag accepts any value or none. |
| `currentState.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | read-only | Kinds of object the tag can be applied to |
| `currentState.description` | string | read-only | Description of the tag. Null when it has none. |
| `currentState.key` | string | read-only | Key of the tag |
| `currentState.kind` | publicCloud.lakehouse.TagKindEnum | read-only | Whether the tag is predefined or custom — one of `CUSTOM`, `PREDEFINED` |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the tag 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 tag, and its last failed task while the tag 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 tag |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the tag. A change is accepted only in READY or ERROR. 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.TagTargetSpec | read-only | Last requested specification of the tag |
| `targetSpec.allowedValues` | string[] | yes | Values the tag accepts, at most 100 and each unique. A value follows the rules of the key, and the key, a colon and the value are at most 63 characters together. An empty list lets the tag be applied with any value or with none. |
| `targetSpec.appliesTo` | publicCloud.lakehouse.TagTargetEnum[] | yes | Kinds of object the tag can be applied to, at least one and each once |
| `targetSpec.description` | string |  | Description of the tag. Null or omitted when the tag has none. At most 2000 characters. |
| `targetSpec.key` | string | yes | Key of the tag, unique in the lakehouse: 1 to 63 lowercase letters, digits, underscores, dots or hyphens, starting with a letter or a digit. The keys of the predefined tags (`pii`, `sensitivity`, `deprecated`, `domain`) are reserved. Immutable after creation. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the tag |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string",
    "kind": "CUSTOM",
    "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": {
    "allowedValues": [
      "string"
    ],
    "appliesTo": [
      "COLUMN"
    ],
    "description": "string",
    "key": "string"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}" \
  -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.TagUpdate
result = client.put("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}",
	checksum = None, # Checksum of the tag as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the tag changed since. When omitted or empty, no check is made. (type: string, nullable)
	targetSpec = None, # New specification of the tag. It replaces the whole current specification: an optional field you omit is reset to its default, and `allowedValues` and `appliesTo` replace the whole lists. Send only the fields of this model: a field that can only be set at creation is refused. (type: publicCloud.lakehouse.TagUpdateTargetSpec)
)

# 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.TagUpdate
$result = $ovh->put("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId}", array(
	checksum => null, // Checksum of the tag as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the tag changed since. When omitted or empty, no check is made. (type: string, nullable)
	targetSpec => null, // New specification of the tag. It replaces the whole current specification: an optional field you omit is reset to its default, and `allowedValues` and `appliesTo` replace the whole lists. Send only the fields of this model: a field that can only be set at creation is refused. (type: publicCloud.lakehouse.TagUpdateTargetSpec)
));

print_r($result);
?>
```

## List the tasks of a tag of your lakehouse

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

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

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/tag/task/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 |
| `tagId` | path | string (uuid) | yes | Tag 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}/tag/{tagId}/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}/tag/{tagId}/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}/tag/{tagId}/task");

print_r($result);
?>
```

## Get a task of a tag of your lakehouse

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

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

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `tagId` | path | string (uuid) | yes | Tag 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}/tag/{tagId}/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}/tag/{tagId}/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}/tag/{tagId}/task/{taskId}");

print_r($result);
?>
```

## List the events of a tag of your lakehouse

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

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

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/tag/event/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 |
| `tagId` | path | string (uuid) | yes | Tag 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}/tag/{tagId}/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}/tag/{tagId}/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}/tag/{tagId}/event");

print_r($result);
?>
```
