Skip to content

Tags

All operations require authentication.

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

List the tags of your lakehouseAlpha

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

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.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Tag[]successful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the tag was created

currentState
read-only
TagCurrentState

Current state of the tag, computed by the service

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the tag

resourceStatus
read-only
ResourceStatusEnum

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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
TagTargetSpec

Last requested specification of the tag

updatedAt
read-only
stringdate-time

Date of the last change to the tag

400objectError 400 response
404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "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" }]

Get a tag of your lakehouseAlpha

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

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

tagId
required
stringuuid

Tag ID

Response

200Tagsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the tag was created

currentState
read-only
TagCurrentState

Current state of the tag, computed by the service

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the tag

resourceStatus
read-only
ResourceStatusEnum

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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
TagTargetSpec

Last requested specification of the tag

updatedAt
read-only
stringdate-time

Date of the last change to the tag

400objectError 400 response
404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

Create a custom tag in your lakehouseAlpha

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

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.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

targetSpec
required
TagTargetSpec

Specification of the tag to create

Response

200Tagsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the tag was created

currentState
read-only
TagCurrentState

Current state of the tag, computed by the service

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the tag

resourceStatus
read-only
ResourceStatusEnum

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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
TagTargetSpec

Last requested specification of the tag

updatedAt
read-only
stringdate-time

Date of the last change to the tag

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

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

Delete a custom tag of your lakehouseAlpha

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

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.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

tagId
required
stringuuid

Tag ID

Response

200Tagsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the tag was created

currentState
read-only
TagCurrentState

Current state of the tag, computed by the service

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the tag

resourceStatus
read-only
ResourceStatusEnum

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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
TagTargetSpec

Last requested specification of the tag

updatedAt
read-only
stringdate-time

Date of the last change to the tag

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

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

Update a tag of your lakehouseAlpha

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

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).

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

tagId
required
stringuuid

Tag ID

Request body (required)

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
required
TagUpdateTargetSpec

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.

Response

200Tagsuccessful operation
checksum
read-only
string

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

createdAt
read-only
stringdate-time

Date the tag was created

currentState
read-only
TagCurrentState

Current state of the tag, computed by the service

currentTasks
read-only
CurrentTask[]

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.

id
read-only
stringuuid

Unique identifier of the tag

resourceStatus
read-only
ResourceStatusEnum

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.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
TagTargetSpec

Last requested specification of the tag

updatedAt
read-only
stringdate-time

Date of the last change to the tag

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

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

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/tag/{tagId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

List the tasks of a tag of your lakehouseAlpha

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

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

tagId
required
stringuuid

Tag ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

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

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

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

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

Get a task of a tag of your lakehouseAlpha

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

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

tagId
required
stringuuid

Tag ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

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

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

List the events of a tag of your lakehouseAlpha

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

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

tagId
required
stringuuid

Tag ID

Query parameters

taskId
stringuuid

Return only the events of this task

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

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

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS
400objectError 400 response
404objectError 404 response

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

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