Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
    AI Lake - Databases
      (BETA) List AI Lake Database instancesget(BETA) Create a new AILake Database instancepost(BETA) Get the specified AILake Database instanceget(BETA) Delete an existing AILake Database instancedelete
    AI Lake - Pipe Tables
    AI Lake - Services & Operations
Other
Schemas
powered by Zudoku
OpenAPI definition

AI Lake - Databases

Endpoint:/

(BETA) List AI Lake Database instances

GET
/api/v1/ailake/database/instances

(BETA) Lists database instances in the organization's AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count.

(BETA) List AI Lake Database instances › query Parameters

  • sizeinteger · int32
    Default: 50
  • offsetinteger · int32
    Default: 0
  • metaIncludestring[] · unique

(BETA) List AI Lake Database instances › Responses

AI Lake database instances successfully retrieved

  • databasesobject[] · required

    List of database instances

  • totalCountinteger · int32

    Total count of items (only set when metaInclude=page)

GET /api/v1/ailake/database/instances

(BETA) Create a new AILake Database instance

POST
/api/v1/ailake/database/instances

(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.

(BETA) Create a new AILake Database instance › Headers

  • operation-idstring

(BETA) Create a new AILake Database instance › Request Body

  • namestring · required

    Name of the database instance

  • storageIdsstring[] · unique · required

    Set of ids of the storage instances this database instance should access.

(BETA) Create a new AILake Database instance › Responses

Accepted

POST /api/v1/ailake/database/instances

(BETA) Get the specified AILake Database instance

GET
/api/v1/ailake/database/instances/{instanceId}

(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.

(BETA) Get the specified AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Get the specified AILake Database instance › Responses

AI Lake database instance successfully retrieved

  • idstring · required

    Id of the AI Lake Database instance

  • namestring · required

    Name of the AI Lake Database instance

  • storageIdsstring[] · unique · required

    Set of ids of the storage instances this database instance should access.

GET /api/v1/ailake/database/instances/{instanceId}

(BETA) Delete an existing AILake Database instance

DELETE
/api/v1/ailake/database/instances/{instanceId}

(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.

(BETA) Delete an existing AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Delete an existing AILake Database instance › Headers

  • operation-idstring

(BETA) Delete an existing AILake Database instance › Responses

Accepted

DELETE /api/v1/ailake/database/instances/{instanceId}
Export templatesAI Lake - Pipe Tables