Manage Catalogs

Artifact also provides a set of methods for catalog management, including listing, updating, and deleting catalogs.

Manage Catalogs via API

List Catalogs

This endpoint returns a list your Catalogs, including their metadata.

export INSTILL_API_TOKEN=********

curl -X GET 'http://localhost:8080/v1alpha/namespaces/NAMESPACE_ID/catalogs' \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

from instill.clients.client import init_artifact_client

artifact = init_artifact_client(api_token="INSTILL_API_TOKEN", url="http://localhost:8080")
artifact.list_catalogs(namespace_id="NAMESPACE_ID")
artifact.close()

Update Catalog

This endpoint enables you to update a Catalog's description.

export INSTILL_API_TOKEN=********

curl -X PUT 'http://localhost:8080/v1alpha/namespaces/NAMESPACE_ID/catalogs/CATALOG_ID' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN" \
--data '{
"description": "Updated description of your Catalog",
"tags": ["updated_tag1", "updated_tag2"]
}'

from instill.clients.client import init_artifact_client

artifact = init_artifact_client(api_token="INSTILL_API_TOKEN", url="http://localhost:8080")
artifact.update_catalog(
    namespace_id="NAMESPACE_ID",
    catalog_id="CATALOG_ID",
    description="Updated description of your Catalog",
    tags=["updated_tag1", "updated_tag2"],
)
artifact.close()

Delete Catalog

This endpoint enables you to delete a Catalog.

🚧
Please note that once a Catalog is deleted, all related uploaded and processed files will be deleted as well.

export INSTILL_API_TOKEN=********

curl -X DELETE 'http://localhost:8080/v1alpha/namespaces/NAMESPACE_ID/catalogs/CATALOG_ID' \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

from instill.clients.client import init_artifact_client

artifact = init_artifact_client(api_token="INSTILL_API_TOKEN", url="http://localhost:8080")
artifact.delete_catalog(namespace_id="NAMESPACE_ID", catalog_id="CATALOG_ID")
artifact.close()

Note that the NAMESPACE_ID and CATALOG_ID path parameters must be replaced
by the Catalog owner's ID (namespace) and the identifier of the Catalog to be deleted, respectively.

Manage Catalogs via Console

List Catalogs

To list the Catalogs under a namespace in Console, follow these steps:

Launch Console locally at http://localhost:3000.

Navigate to the Artifacts page using the navigation bar.

Your Catalogs will automatically appear below.

Update Catalog

To update a Catalog's description in Console, follow these steps:

Launch Console locally at http://localhost:3000.

Navigate to the Artifacts page using the navigation bar.
Click ... in the bottom-right of the Catalog card you wish to update.
Select Edit Info.

Delete Catalog

🚧
Please note that once a Catalog is deleted, all related uploaded and processed files will be deleted as well.

To delete a Catalog in Console, follow these steps:

Launch Console locally at http://localhost:3000.

Navigate to the Artifacts page using the navigation bar.
Click ... in the bottom-right of the Catalog card you wish to delete.
Select Delete.