Introduction Use the Db2 Warehouse as a Service API to access data, view and create database objects, administer, and monitor your Db2 Warehouse as a Service service. Root URL The context root for the
| Method | Path | Summary |
|---|---|---|
| Request a new access token | ||
| Returns public key of Json Web Token | ||
| Perform logout operation for a token | ||
| Creates a new authentication policy **ADMIN ONLY** | ||
| Lists all authentication policies **ADMIN ONLY** | ||
| Returns an authentication policy **ADMIN ONLY** | ||
| Updates an authentication policy **ADMIN ONLY** | ||
| Deletes an existing policy **ADMIN ONLY** | ||
| Sets a new password using dswebToken | ||
| Requests a password reset based on user's email | ||
| Get a list of backups | ||
| Restore | ||
| Create a backup | ||
| Delete a backup | ||
| Get backup setting | ||
| Update backup setting | ||
| Creates a data load job, load uses external table technology | ||
| Lists all data load jobs, load uses Db2 load utility technology | ||
| Creates a data load job | ||
| Returns details about a load job including its progress | ||
| Removes load job from history | ||
| Dowloads log file for a data load job | ||
| Lists all schemas in the database | ||
| Returns schema information | ||
| Lists tables in a schema | ||
| Returns information about a table | ||
| Deletes all table data | ||
| Query the list of object schemas | ||
| Create schema | ||
| Drops an empty schema | ||
| Get single object privilege | ||
| Privilege list of selected objects | ||
| Grant or revoke privileges | ||
| Generate schema DDL | ||
| Create a new table | ||
| Drop table | ||
| Get table definition | ||
| Query table data | ||
| Get column detail properties | ||
| Get the metadata type | ||
| Generate table DDL | ||
| Get distributin keys | ||
| Get data distributin property | ||
| Get partition expressions | ||
| Get data partitions | ||
| Query view detail properties | ||
| Drop views | ||
| Query view data | ||
| Get View definition | ||
| Generate view DDL | ||
| Get the dependencies of the object | ||
| Get the dependencies of the tablespace | ||
| Query bufferpool detail properties | ||
| Query constraint detail properties | ||
| Query index detail properties | ||
| Query trigger detail properties | ||
| Query MQT detail properties | ||
| Query UDF detail properties | ||
| Query tablespace detail properties | ||
| Query procedure detail properties | ||
| Query sequence detail properties | ||
| Query package detail properties | ||
| Query UDT detail properties | ||
| Query alias detail properties | ||
| Get table detail properties | ||
| Create alias | ||
| Drop alias | ||
| Generate Alias DDL | ||
| Query alias data | ||
| Get the SQL statement template for creating MQT table | ||
| Delete mqt tables | ||
| Get the definition of MQT table | ||
| Get the data of specified mqt table | ||
| Get authentications through the authid filter | ||
| Get the privieles of auth id | ||
| Get SQL statement of grant or revoke privileges | ||
| Add new role | ||
| Grant or revoke the privilges of role | ||
| Delete one role | ||
| Get the membership of authid | ||
| Get SQL statement of grant or revoke role | ||
| Get SQL statement for grant or revoke privileges | ||
| Grant or revole privileges for multiple objects and objects type | ||
| Get the SQL statement for grant or revoke multiple roles | ||
| Grant or revoke multiple roles | ||
| Generate workload DDL | ||
| Lists workloads | ||
| Drop sequences | ||
| Drop procedures | ||
| Retrieve parameters for procedure | ||
| Generate create procedure template | ||
| Drop functions | ||
| Retrieve parameters for specific udf | ||
| Generate create function template | ||
| Drop User-defined Types | ||
| Retrieve row definition for User-defined Type object | ||
| Generate Create User-defined Types template | ||
| Query the list of tablespace | ||
| Drop tablespaces | ||
| Get the I/O settings of the tablespace | ||
| Get the tablespace size | ||
| Generate visual explain model for a given sql | ||
| Get visual explain nodes information | ||
| Generate visual explain layout | ||
| Get the data of the selected node | ||
| Search node based on the key word and predefined rule | ||
| Search node based on the key word and predefined rule | ||
| Returns metadata of an item in the user's home storage | ||
| Deletes a file in the user's home storage | ||
| Download file from user's home storage | ||
| Uploads a file to the user's home storage | ||
| Retrieves current configuration | ||
| Migrate key | ||
| Returns Key Protect instance information | ||
| Returns keys for given Key Protect instance | ||
| Returns overall status of system components | ||
| Lists active database connections **DB ADMIN ONLY** | ||
| Terminates a database connection **DB ADMIN ONLY** | ||
| Returns current storage usage **DB ADMIN ONLY** | ||
| Returns storage usage history **DB ADMIN ONLY** | ||
| Storage utilization by schema **DB ADMIN ONLY** | ||
| Storage utilization of a schema **DB ADMIN ONLY** | ||
| Return the number of statements for a specified time frame. **DB ADMIN ONLY** | ||
| Return the histogram of response time for a specified time frame. **DB ADMIN ONLY** | ||
| Return the average response time for a specified time frame. **DB ADMIN ONLY** | ||
| Return the list of average response time for a specified time frame. **DB ADMIN ONLY** | ||
| Return the average number of statements executed every minutes for a specified time frame. **DB ADMIN ONLY** | ||
| Return numbers of statements executed every minutes for a specified time frame. **DB ADMIN ONLY** | ||
| Return the average number of rows read(rows/min) for a specified time frame. **DB ADMIN ONLY** | ||
| Return the numbers of rows read(rows/min) for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum number of concurrent connections for a specified time frame **DB ADMIN ONLY** | ||
| Return maximum numbers of concurrent connections for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum lockwaits per minute for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum lockwaits per minute for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum usage percentage of logs for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum usage percentages of logs for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum percent of node CPU usage for a specified time frame. **DB ADMIN ONLY** | ||
| Return the percent of node CPU usage for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum percent of node memory usage for a specified time frame. **DB ADMIN ONLY** | ||
| Return the percent of node memory usage for a specified time frame. **DB ADMIN ONLY** | ||
| Return the maximum usage percent of storage for a specified time frame. **DB ADMIN ONLY** | ||
| Return the usage percent of storage for a specified time frame. **DB ADMIN ONLY** | ||
| Return the time spent in each operation for a specified time frame. **DB ADMIN ONLY** | ||
| Return a table storage usage in a time range **DB ADMIN ONLY** | ||
| Returns a list for tables storage **DB ADMIN ONLY** | ||
| Returns a table storage **DB ADMIN ONLY** | ||
| Returns a list for schemas storage **DB ADMIN ONLY** | ||
| Return a schema used storage in a time range **DB ADMIN ONLY** | ||
| Returns a schema storage **DB ADMIN ONLY** | ||
| Runs a tables storage collection **DB ADMIN ONLY** | ||
| Returns a list of inflight executions | ||
| Returns a list of current inflight executions | ||
| Returns a infight execution detail | ||
| Terminates a statement **DB ADMIN ONLY** | ||
| Returns a list of connections | ||
| Returns a list of current connections | ||
| Returns a connection detail | ||
| Terminates a database connection **DB ADMIN ONLY** | ||
| Returns a list of timeseries of a connection | ||
| Returns performance metrics for schemas **DB ADMIN ONLY** | ||
| Returns performance metrics for schemas **DB ADMIN ONLY** | ||
| Returns performance metrics for one schema **DB ADMIN ONLY** | ||
| Returns performance metrics on all members for one schema **DB ADMIN ONLY** | ||
| Returns performance metrics timeseries for one schema **DB ADMIN ONLY** | ||
| Returns performance of tables **DB ADMIN ONLY** | ||
| Returns current performance of tables **DB ADMIN ONLY** | ||
| Returns performance of one table **DB ADMIN ONLY** | ||
| Returns performance on all members for one table **DB ADMIN ONLY** | ||
| Returns performance timeseries for one table **DB ADMIN ONLY** | ||
| Returns performance of tables and schemas **DB ADMIN ONLY** | ||
| Returns current performance of tables and schemas **DB ADMIN ONLY** | ||
| Executes SQL statements | ||
| Fetches partial results of a SQL job execution | ||
| Returns the results of a SQL query to CSV | ||
| Create a scaling request | ||
| Cancel a pending scaling request | ||
| Get the last scaling request status | ||
| Get the complete list of scaling requests | ||
| Get supported scaling ranges and current allocated resources | ||
| View scaling history saved in console | ||
| Returns the system's current settings | ||
| Updates the system settings **ADMIN ONLY** | ||
| Get tasks status | ||
| Generates a new Aspera token | ||
| Deletes an Aspera token | ||
| Analyzes CSV data to return a list of data types of its values | ||
| Returns the list of users | ||
| Creates a new user. **ADMIN ONLY** | ||
| Get a specific user by ID | ||
| Updates an existing user | ||
| Deletes an existing user **ADMIN ONLY** | ||
| Locks a user account indefinitely. **ADMIN ONLY** | ||
| Unlocks a user account **ADMIN ONLY** | ||
| Get a specific user's connection privileges | ||
| Updates an existing user's connection privileges **ADMIN ONLY** |