Introduction Use the Db2 Warehouse on Cloud v5 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 Db2 Warehouse as a Service API is /dbapi/v5/. Error handling This API uses the following standard HTTP response codes to indicate whether a method completed successfully: - 200: The request was successful. - 400: An error occurred. Security Every request must include the Authorization HTTP header with the value Bearer accesstoken. You can get an access token in one of the following ways: - Using the /auth/tokens endpoint - Creating an IAM access tokenhttps://cloud.ibm.com/apidocs/iam-identity-token-apigettoken-password - Generating an IBM Cloud IAM oauth-tokenhttps://cloud.ibm.com/docs/account?topic=account-iamtokenfromapikey The token is used by Db2 Warehouse as a Service to identify who you are. Every request must include an X-Deployment-Id HTTP header with the value of your Db2 Warehouse as a Service tenant deployment ID. The ID starts with crn.You can view your instance's CRN by clicking on the instance in your Resource Listhttps://cloud.ibm.com/resources. Db2 Warehouse as a Service negotiates SSL connections by using the TLS v1.2 protocol. With current versions of cURL, protocol negotiation happens automatically by using TLS v1.2. If you are using an older version of cURL, include the --tlsv1.2 option in your cURL commands to force the request to use the TLS 1.2 protocol.
| Method | Path | Summary |
|---|---|---|
| POST | /auth/tokens | Request a new access token |
| GET | /auth/token/publickey | Returns public key of Json Web Token |
| DELETE | /auth/token/logout | Perform logout operation for a token |
| GET | /auth_policies | Lists all authentication policies **ADMIN ONLY** |
| POST | /auth_policies | Creates a new authentication policy **ADMIN ONLY** |
| GET | /auth_policies/{id} | Returns an authentication policy **ADMIN ONLY** |
| PUT | /auth_policies/{id} | Updates an authentication policy **ADMIN ONLY** |
| DELETE | /auth_policies/{id} | Deletes an existing policy **ADMIN ONLY** |
| PUT | /auth/password | Sets a new password using dswebToken |
| POST | /auth/reset | Requests a password reset based on user's email |
| GET | /schemas | Lists all schemas in the database |
| GET | /schemas/{schema_name} | Returns schema information |
| GET | /schemas/{schema_name}/tables | Lists tables in a schema |
| GET | /schemas/{schema_name}/tables/{table_name} | Returns information about a table |
| DELETE | /schemas/{schema_name}/tables/{table_name}/data | Deletes all table data |
| GET | /admin/schemas/obj_type/{obj_type} | Query the list of object schemas |
| POST | /admin/schemas | Create schema |
| PUT | /admin/schemas/delete | Drops multiple schemas |
| GET | /admin/privileges | Get single object privilege |
| PUT | /admin/privileges | Grant or revoke privileges |
| POST | /admin/privileges | Privilege list of selected objects |
| POST | /admin/schemas/ddl | Generate schema DDL |
| PUT | /admin/tables | Create a new table |
| PUT | /admin/tables/delete | Drop multiple tables |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/definition | Get table definition |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/data | Query table data |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/columns/{column_name}/properties | Get column detail properties |
| GET | /admin/tables/meta/datatype | Get the metadata type |
| POST | /admin/tables/ddl | Generate table DDL |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/distribution_keys | Get distributin keys |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/distributions/properties | Get data distributin property |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/partitions/expressions | Get partition expressions |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/partitions | Get data partitions |
| POST | /admin/tables/move_activity | Move tables |
| POST | /admin/tables/move_activity/script | Move tables script |
| POST | /admin/tables/copy_activity | Copy tables |
| POST | /admin/tables/copy_activity/script | Copy tables script |
| POST | /admin/tables/tasks/status | Get the latest status after last updated time |
| GET | /admin/schemas/{schema_name}/views/{view_name}/properties | Query view detail properties |
| PUT | /admin/views/delete | Drop multiple views |
| GET | /admin/schemas/{schema_name}/views/{view_name}/data | Query view data |
| GET | /admin/schemas/{schema_name}/views/{view_name}/definition | Get View definition |
| POST | /admin/views/ddl | Generate view DDL |
| GET | /admin/schemas/{schema_name}/{obj_type}/{object_name}/dependencies | Get the dependencies of the object |
| GET | /admin/tablespaces/{tablespace}/dependencies | Get the dependencies of the tablespace |
| GET | /admin/bufferpools/{bufferpool_name}/properties | Query bufferpool detail properties |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties | Query constraint detail properties |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties | Query index detail properties |
| GET | /admin/schemas/{schema_name}/triggers/{trigger_name}/properties | Query trigger detail properties |
| GET | /admin/schemas/{schema_name}/mqts/{mqt_name}/properties | Query MQT detail properties |
| GET | /admin/schemas/{schema_name}/functions/{specific_name}/properties | Query UDF detail properties |
| GET | /admin/tablespaces/{table_space}/properties | Query tablespace detail properties |
| GET | /admin/schemas/{schema_name}/procedures/{specific_name}/properties | Query procedure detail properties |
| GET | /admin/schemas/{schema_name}/sequences/{sequence_name}/properties | Query sequence detail properties |
| GET | /admin/schemas/{schema_name}/packages/{package_name}/properties | Query package detail properties |
| GET | /admin/schemas/{schema_name}/udts/{type_name}/properties | Query UDT detail properties |
| GET | /admin/schemas/{schema_name}/aliases/{alias_name}/properties | Query alias detail properties |
| GET | /admin/schemas/{schema_name}/tables/{table_name}/properties | Get table detail properties |
| PUT | /admin/aliases | Create alias |
| PUT | /admin/aliases/delete | Drop multiple aliases |
| POST | /admin/aliases/ddl | Generate Alias DDL |
| GET | /admin/schemas/{schema_name}/aliases/{alias_name}/data | Query alias data |
| POST | /admin/mqts/ddl | Get the SQL statement template for creating MQT table |
| PUT | /admin/mqts/delete | Delete multiple mqt tables |
| GET | /admin/schemas/{schema_name}/mqts/{mqt_name}/definition | Get the definition of MQT table |
| GET | /admin/schemas/{schema_name}/mqts/{mqt_name}/data | Get the data of specified mqt table |
| GET | /admin/privileges/authentications | Get authentications through the authid filter |
| GET | /admin/privileges/{authid_type}/{authid}/{obj_type} | Get the privieles of auth id |
| POST | /admin/privileges/dcl | Get SQL statement of grant or revoke privileges |
| PUT | /admin/privileges/roles | Grant or revoke the privilges of role |
| POST | /admin/privileges/roles | Add new role |
| DELETE | /admin/privileges/roles/{role_name} | Delete one role |
| GET | /admin/privileges/roles/{authid_type}/{authid} | Get the membership of authid |
| POST | /admin/privileges/roles/dcl | Get SQL statement of grant or revoke role |
| POST | /admin/privileges/multiple_objtypes/dcl | Get SQL statement for grant or revoke privileges |
| PUT | /admin/privileges/multiple_objtypes | Grant or revole privileges for multiple objects and objects type |
| POST | /admin/privileges/multiple_roles/dcl | Get the SQL statement for grant or revoke multiple roles |
| PUT | /admin/privileges/multiple_roles | Grant or revoke multiple roles |
| PUT | /admin/nicknames | Create nicknames |
| PUT | /admin/nicknames/delete | Delete multiple nicknames |
| GET | /admin/schemas/{schema_name}/nicknames/{nickname}/definition | Get nickname definition |
| POST | /admin/nicknames/ddl | Generate nickname DDL |
| GET | /admin/schemas/{schema_name}/nicknames/{nickname}/properties | Get nickname detail properties |
| GET | /admin/schemas/{schema_name}/nicknames/{nickname}/data | Get nickname data |
| GET | /admin/remoteServers | List remote servers |
| POST | /admin/remoteServers | Create remote server |
| PUT | /admin/remoteServers/delete | Delete multiple remote servers |
| GET | /admin/remoteServers/{server_name}/properties | Get server properties |
| POST | /admin/remoteServers/ddl | Generate server DDL |
| GET | /admin/usermappings | Lists usermappings |
| PUT | /admin/usermappings | Alter usermapping |
| POST | /admin/usermappings | Create usermappings |
| PUT | /admin/usermappings/delete | Delete multiple usermappings |
| POST | /admin/usermappings/ddl | Generate usermapping DDL |
| GET | /admin/usermappings/localusers/{local_user}/remoteservers/{server_name}/properties | Get usermapping detail properties |
| POST | /admin/remoteTables | Lists the remote tables |
| POST | /admin/remoteSchemas | Lists the remote schemas |
| POST | /admin/workloads/ddl | Generate workload DDL |
| GET | /admin/workloads | Lists workloads |
| PUT | /admin/sequences/delete | Drop multiple sequences |
| PUT | /admin/procedures/delete | Drop multiple procedures |
| GET | /admin/schemas/{schema_name}/procedures/{specific_name}/parameters | Retrieve parameters for procedure |
| POST | /admin/procedures/ddl | Generate create procedure template |
| PUT | /admin/functions/delete | Drop multiple functions |
| GET | /admin/schemas/{schema_name}/functions/{specific_name}/parameters | Retrieve parameters for specific udf |
| POST | /admin/functions/ddl | Generate create function template |
| PUT | /admin/udts/delete | Drop multiple User-defined Types |
| GET | /admin/schemas/{schema_name}/udts/{udt_name}/definition | Retrieve row definition for User-defined Type object |
| POST | /admin/udts/ddl | Generate Create User-defined Types template |
| GET | /admin/tablespaces | Query the list of tablespace |
| PUT | /admin/tablespaces/delete | Drop multiple tablespaces |
| GET | /admin/tablespaces/{tablespace}/iosetting | Get the I/O settings of the tablespace |
| GET | /admin/tablespaces/{tablespace}/size | Get the tablespace size |
| GET | /admin/tables/tasks | Get all admin tasks list |
| GET | /admin/tables/tasks/detail/{task_id} | Get detail information of a task |
| GET | /admin/bucket_aliases | Query the list of object storage aliases |
| PUT | /admin/bucket_alias | Create object storage alias |
| DELETE | /admin/bucket_alias/{alias_name} | Delete object storage alias |
| POST | /admin/tables/task/export_odf | Export table to ODF format |
| POST | /admin/tables/task/export_odf/script | Get script used for exporting table to ODF format |
| PUT | /admin/datalaketables | Create a datalake table |
| POST | /admin/datalaketables/ddl | Get script of creating datalake table |
| GET | /admin/schemas/{schema_name}/datalaketables/{table_name}/properties | Get properties of datalake table |
| GET | /admin/schemas/{schema_name}/datalaketables/{table_name}/definition | Retrieve row definition for datalake table |
| POST | /load_jobs_ET | Creates a data load job, load uses external table technology |
| GET | /load_jobs | Lists all data load jobs, load uses Db2 load utility technology |
| POST | /load_jobs | Creates a data load job |
| GET | /load_jobs/{id} | Returns details about a load job including its progress |
| DELETE | /load_jobs/{id} | Removes load job from history |
| GET | /load_jobs/{id}/log | Downloads log file for a data load job |
| POST | /admin/tables/task/import_alias | Import to table from storage alias |
| GET | /admin/tables/import_alias/{alias_name}/objects/schema_discovery | Discover schema of object data from object storage alias |
| DELETE | /home/{path} | Deletes a file in the user's home storage |
| GET | /home_content/{path} | Download file from user's home storage |
| POST | /home_content/{path} | Uploads a file to the user's home storage |
| POST | /sql_jobs | Executes SQL statements |
| GET | /sql_jobs/{id} | Fetches partial results of a SQL job execution |
| POST | /sql_query_export | Returns the results of a SQL query to CSV |
| GET | /monitor | Returns overall status of system components |
| GET | /metrics/average_response_time | Return the average response time for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/average_statements_rate | Return the average number of statements executed every minutes for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/average_rows_read | Return the average number of rows read(rows/min) for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/rows_read | Return the numbers of rows read(rows/min) for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/max_connections_count | Return the maximum number of concurrent connections for a specified time frame **DB ADMIN ONLY** |
| GET | /metrics/connections_count | Return maximum numbers of concurrent connections for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/max_lockwaits_rate | Return the maximum lockwaits per minute for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/lockwaits_rate | Return the maximum lockwaits per minute for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/max_log_space | Return the maximum usage percentage of logs for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/log_space | Return the maximum usage percentages of logs for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/max_cpu | Return the maximum percent of node CPU usage for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/cpu_summary | Return the percent of node CPU usage for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/max_memory | Return the maximum percent of node memory usage for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/memory_summary | Return the percent of node memory usage for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/timespent | Return the time spent in each operation for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/schemas | Returns performance metrics for schemas **DB ADMIN ONLY** |
| GET | /metrics/locking/blocking_and_waiting_connections | Returns a list of blocking transactions. **DB ADMIN ONLY** |
| GET | /metrics/locking/blocking_and_waiting_connections/current/list | Returns a list of blocking transactions. **DB ADMIN ONLY** |
| GET | /metrics/locking/blocking_and_waiting_connections/holder/{application_handle} | Returns the blocking transactions. **DB ADMIN ONLY** |
| GET | /metrics/locking/blocking_and_waiting_connections/waiter/{application_handle} | Returns the waiting transactions. **DB ADMIN ONLY** |
| GET | /metrics/locking/locked_objects_with_waiting_connections | Returns a list of history locked objects with waiting connections. **DB ADMIN ONLY** |
| GET | /metrics/locking/locked_objects_with_waiting_connections/current/list | Returns a list of current locked objects with waiting connections. **DB ADMIN ONLY** |
| GET | /metrics/locking/locked_objects_with_waiting_connections/{hld_application_handle} | Returns the locked objects with waiting connections. **DB ADMIN ONLY** |
| GET | /metrics/locking/find_locked_objects | Returns a list of history locked objects |
| GET | /metrics/locking/find_locked_objects/current/list | Returns a list of current locked objects |
| GET | /metrics/locking/find_locked_objects/{application_handle} | Returns the locked objects |
| GET | /metrics/locking/evmon_locking | Returns a summary of event monitoring locking |
| GET | /metrics/locking/evmon_locking/current/list | Returns a list of current event monitor locking |
| GET | /metrics/locking/evmon_locking/event_id/{id}/holder_member/{member}/waiter_member/{w_member}/holder_application_handle/{handle}/waiter_application_handle/{w_handle}/holder_activity_id/{h_id}/waiter_activity_id/{w_id}/event_timestamp/{timestamp} | Returns an event monitor locking detail |
| GET | /metrics/statements_count | Return the number of statements for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/statements_rate | Return numbers of statements executed every minutes for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/statements/inflight_executions | Returns a list of inflight executions |
| GET | /metrics/statements/inflight_executions/current/list | Returns a list of current inflight executions |
| GET | /metrics/statements/package_cache | Returns performance of package cache **DB ADMIN ONLY** |
| GET | /metrics/statements/package_cache/current/list | Returns current performance of package cache **DB ADMIN ONLY** |
| GET | /metrics/statements/package_cache/{sql_hash_id} | Returns performance of one sql in package cache **DB ADMIN ONLY** |
| GET | /metrics/statements/package_cache/{sql_hash_id}/timeseries | Returns the time series performance data. **DB ADMIN ONLY** |
| GET | /metrics/statements/evmon_activity | Returns a list of event monitor activities **DB ADMIN ONLY** |
| GET | /metrics/statements/evmon_activity/groupby/list | Returns a list of event monitor activities group by a specific field **DB ADMIN ONLY** |
| GET | /metrics/statements/evmon_activity/current/list | Returns a list of current event monitor activities **DB ADMIN ONLY** |
| GET | /metrics/statements/evmon_activity/current/list/groupby/list | Returns a list of current event monitor activities group by a specific field **DB ADMIN ONLY** |
| GET | /metrics/statements/evmon_activity/{application_handle}/uow/{uow_id}/activity/{activity_id} | Returns an event monitor activity detail **DB ADMIN ONLY** |
| GET | /metrics/statements/stored_procedures | Returns a list of stored procedures |
| GET | /metrics/statements/stored_procedures/current/list | Returns a list of current stored procedures |
| GET | /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id} | Returns a infight execution detail |
| DELETE | /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id} | Terminates a statement **DB ADMIN ONLY** |
| GET | /metrics/applications/connections | Returns a list of connections |
| GET | /metrics/applications/connections/current/list | Returns a list of current connections |
| GET | /metrics/applications/connections/{application_handle} | Returns a connection detail |
| DELETE | /metrics/applications/connections/{application_handle} | Terminates a database connection **DB ADMIN ONLY** |
| GET | /metrics/applications/connections/{application_handle}/timeseries | Returns a list of timeseries of a connection |
| GET | /metrics/applications/uow | Returns a list of units of works **DB ADMIN ONLY** |
| GET | /metrics/applications/uow/current/list | Returns a list of current connections **DB ADMIN ONLY** |
| GET | /metrics/applications/{application_handle}/uow/{uow_id} | Returns a units of works detail **DB ADMIN ONLY** |
| GET | /metrics/applications/{application_handle}/uow/{uow_id}/members | Returns a units of works detail **DB ADMIN ONLY** |
| GET | /metrics/applications/evmon_utility | Returns a summary of event monitoring utility |
| GET | /metrics/applications/evmon_utility/current/list | Returns a list of current event monitor utility |
| GET | /metrics/applications/evmon_utility/utility_invocation_id/{utility_invocation_id} | Returns an event monitor utility detail |
| GET | /metrics/applications/topconsumer/current/list | Returns a summary of the current top consumer metrics detail |
| GET | /metrics/applications/topconsumer/ | Returns a summary of historical top consumers during a time period |
| GET | /metrics/applications/topconsumer/{category}/timeseries | Returns a list of timeseries of certain metric's top consumers |
| GET | /monitor/connections | Lists active database connections **DB ADMIN ONLY** |
| DELETE | /monitor/connections/{application_handle} | Terminates a database connection **DB ADMIN ONLY** |
| GET | /metrics/throughput/partition_summary | Returns a list of member summary **DB ADMIN ONLY** |
| GET | /metrics/throughput/partition_summary/current/list | Returns a current list of member summary **DB ADMIN ONLY** |
| GET | /metrics/throughput/partition_summary/{member} | Returns a current list of member summary of a specific member. **DB ADMIN ONLY** |
| GET | /metrics/throughput/partition_summary/{member}/timeseries | Returns a time series list of member summary of a specific member. **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_workload_summary | Returns a list of wlm workload summary **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_workload_summary/{workload_name} | Returns a list of wlm workload summary of a specific workload name. **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_workload_summary/current/list | Returns a current list of wlm workload summary . **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_workload_summary/{workload_name}/members | Returns a list of wlm workload summary of a specific workload name.aggregated by member. **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_workload_summary/{workload_name}/timeseries | Returns a list of wlm workload summary of a specific workload name. **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_service_class_summary | Returns a list of WLM service class summary **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_service_class_summary/current/list | Returns a current list of wlm service class summary **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_service_class_summary/service_superclass/{service_superclass_name}/service_subclass/{service_subclass_name} | Returns a list of WLM service class summary of specific wlm_service_class_summary and service_subclass_name **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_service_class_summary/service_superclass/{service_superclass_name}/service_subclass/{service_subclass_name}/members | Returns a list of WLM service class summary of specific wlm_service_class_summary and service_subclass_name. **DB ADMIN ONLY** |
| GET | /metrics/throughput/wlm_service_class_summary/service_superclass/{service_superclass_name}/service_subclass/{service_subclass_name}/timeseries | Returns a list of WLM service class summary of specific wlm_service_class_summary and service_subclass_name. **DB ADMIN ONLY** |
| GET | /metrics/throughput/partition_skew | Returns a list of database member skew |
| GET | /metrics/throughput/partition_skew/{member} | Returns a current list of database member skew of specific member |
| GET | /metrics/throughput/partition_skew/current/list | Returns a current list of member summary |
| GET | /metrics/throughput/partition_skew/{member}/timeseries | Returns a current list of database member skew of specific member |
| GET | /metrics/throughput/connectionsummary | getConnectionSummaryHistory |
| GET | /metrics/throughput/connectionsummary/current/list | getConnectionSummaryRealTime |
| GET | /metrics/throughput/connectionsummary/{application_handle} | showApplicationHandleDetail |
| GET | /metrics/throughput/connectionsummary/{application_handle}/partition | showPartitionsForApplicationHandle |
| GET | /metrics/throughput/connectionsummary/{application_handle}/partition/{partition_id} | showPartitionDetailForApplicationHandle |
| GET | /metrics/throughput/connectionsummary/{application_handle}/timeseries | getConnectionSummaryHistoryTimeSeries |
| GET | /metrics/throughput/os_time_spent | Returns a summary of operating system time spent |
| GET | /metrics/throughput/os_time_spent/current/list | Returns a summary of the current operating system time spent |
| GET | /metrics/throughput/os_time_spent/{category}/timeseries | Returns a list of timeseries of system operating time spent |
| GET | /monitor/storage | Returns current storage usage **DB ADMIN ONLY** |
| GET | /monitor/storage/history | Returns storage usage history **DB ADMIN ONLY** |
| GET | /monitor/storage/by_schema | Storage utilization by schema **DB ADMIN ONLY** |
| GET | /monitor/storage/by_schema/{schema_name} | Storage utilization of a schema **DB ADMIN ONLY** |
| GET | /metrics/max_storage | Return the maximum usage percent of storage for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/storage | Return the usage percent of storage for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries | Return a table storage usage in a time range **DB ADMIN ONLY** |
| GET | /metrics/tables/storage | Returns a list for tables storage **DB ADMIN ONLY** |
| GET | /metrics/schemas/{tabschema}/tables/{tabname}/storage | Returns a table storage **DB ADMIN ONLY** |
| GET | /metrics/storage/schemas | Returns a list for schemas storage **DB ADMIN ONLY** |
| GET | /metrics/storage/schemas/{tabschema}/timeseries | Return a schema used storage in a time range **DB ADMIN ONLY** |
| GET | /metrics/storage/schemas/{tabschema} | Returns a schema storage **DB ADMIN ONLY** |
| POST | /metrics/tables/storage/collector | Runs a tables storage collection **DB ADMIN ONLY** |
| GET | /metrics/schemas/current/list | Returns performance metrics for schemas **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name} | Returns performance metrics for one schema **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/members | Returns performance metrics on all members for one schema **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/timeseries | Returns performance metrics timeseries for one schema **DB ADMIN ONLY** |
| GET | /metrics/tables | Returns performance of tables **DB ADMIN ONLY** |
| GET | /metrics/tables/current/list | Returns current performance of tables **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/tables/{table_name} | Returns performance of one table **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/tables/{table_name}/members | Returns performance on all members for one table **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/tables/{table_name}/timeseries | Returns performance timeseries for one table **DB ADMIN ONLY** |
| GET | /metrics/tableperformance | Returns performance of tables and schemas **DB ADMIN ONLY** |
| GET | /metrics/tableperformance/current/list | Returns current performance of tables and schemas **DB ADMIN ONLY** |
| GET | /metrics/memory/instance_memory | Returns a list of instance memory data |
| GET | /metrics/memory/instance_memory/current/list | Returns a list of current instance memory data |
| GET | /metrics/memory/instance_memory/host_name/{host_name}/db_name/{db_name}/memory_set_type/{memory_set_type}/members | Returns the instance memory data |
| GET | /metrics/memory/instance_memory/host_name/{host_name}/memory_set_type/{memory_set_type}/members | Returns the instance memory data |
| GET | /metrics/memory/instance_memory/host_name/{host_name}/db_name/{db_name}/memory_set_type/{memory_set_type}/timeseries | Returns the time series performance data of instance memory data |
| GET | /metrics/memory/instance_memory/host_name/{host_name}/memory_set_type/{memory_set_type}/timeseries | Returns the time series performance data of instance memory data |
| GET | /metrics/memory/database_memory | Returns a list of database memory data |
| GET | /metrics/memory/database_memory/current/list | Returns a list of current database memory data |
| GET | /metrics/memory/database_memory/memory_pool_type/{memory_pool_type}/members | Returns the database memory data |
| GET | /metrics/memory/database_memory/memory_pool_type/{memory_pool_type}/timeseries | Returns the time series performance data of database memory data |
| GET | /metrics/io/buffer_pool | Returns a list of buffer pool data |
| GET | /metrics/io/buffer_pool/current/list | Returns a list of current buffer pool data |
| GET | /metrics/io/buffer_pool/{bp_name} | Returns the buffer pool data |
| GET | /metrics/io/buffer_pool/{bp_name}/members | Returns performance on all members for one buffer pool data |
| GET | /metrics/io/buffer_pool/{bp_name}/timeseries | Returns the time series performance data of buffer pool data |
| GET | /metrics/io/logging_performance | Returns a list of logging performance data |
| GET | /metrics/io/logging_performance/current/list | Returns a list of current logging performance data |
| GET | /metrics/io/logging_performance/{member} | Returns the logging performance data |
| GET | /metrics/io/logging_performance/{member}/timeseries | Returns the time series performance data of logging performance data |
| GET | /report/scheduler_list | Returns a list of active schedulers |
| GET | /report/scheduler/scheduler_id/{scheduler_id} | Returns a scheduler definition |
| PUT | /report/scheduler/scheduler_id/{scheduler_id} | Edit a scheduler definition |
| POST | /report/scheduler | Creates a new active scheduler |
| GET | /report/result_list | Returns a list of completed schedulers |
| GET | /report/retention/report_history_time | Returns the report history keep time(ms) |
| GET | /report/retention/report_history_count | Returns the report history keep count |
| PUT | /report/retention/report_history_time/{report_history_time} | Update the report history keep time(ms) |
| PUT | /report/retention/report_history_count/{report_history_count} | Update the report history keep count |
| POST | /explain/explain_model | Generate visual explain model for a given sql |
| GET | /explain/explain_model/{sessionId}/diagram/nodes | Get visual explain nodes information |
| POST | /explain/explain_model/{sessionId}/diagram/layout | Generate visual explain layout |
| GET | /explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description | Get the data of the selected node |
| GET | /explain/explain_model/search/{sessionId}/{namePattern} | Search node based on the key word and predefined rule |
| POST | /explain/explain_model/search/{sessionId} | Search node based on the key word and predefined rule |
| GET | /settings | Returns the system's current settings |
| PUT | /settings | Updates the system settings **ADMIN ONLY** |
| POST | /schema_discovery | Analyzes CSV data to return a list of data types of its values |
| PUT | /db2audit/credentials | Enable Db2 audit or configure object storage for Db2 audit feature |
| GET | /db2audit/data_path | Get the object storage alias used by Db2 audit feature |
| GET | /admin/external_metastores | Get the list of all the registered external metastores |
| POST | /admin/external_metastores | Register an external metastore |
| GET | /admin/external_metastores/{external_metastore_name} | Get the specific registered external metastore |
| DELETE | /admin/external_metastores/{external_metastore_name} | Unregister the exeternal metasore |
| PATCH | /admin/external_metastores/{external_metastore_name} | Set the particular property of the exeternal metasore |
| GET | /manage/pausecompute | Perform a pause |
| DELETE | /manage/resumecompute | Resume from a pause |
| GET | /manage/backups | Get a list of backups |
| POST | /manage/backups/restore | Restore |
| POST | /manage/backups/backup | Create a backup |
| GET | /manage/backups/setting | Get backup setting |
| POST | /manage/backups/setting | Update backup setting |
| GET | /manage/backups/history | Get backup history |
| PUT | /manage/scaling/add | Create a scaling request |
| DELETE | /manage/scaling/cancel/{request_id} | Cancel a scheduled scaling request |
| GET | /manage/scaling/resources | Get supported scaling ranges and current allocated resources |
| GET | /manage/scaling/history | View scaling history |
| GET | /manage/tasks/status | Get tasks status |
| GET | /manage/pause/status | Get pause status |
| GET | /users | Returns the list of users |
| POST | /users | Creates a new user. **PLATFORM ADMIN ONLY** |
| GET | /users/{id} | Get a specific user by ID |
| PUT | /users/{id} | Updates an existing user **PLATFORM ADMIN ONLY** |
| DELETE | /users/{id} | Deletes an existing user **PLATFORM ADMIN ONLY** |
| PUT | /users/{id}/lock | Locks a user account indefinitely. **PLATFORM ADMIN ONLY** |
| PUT | /users/{id}/unlock | Unlocks a user account **PLATFORM ADMIN ONLY** |
| GET | /dbsettings/endpoints | Get database endpoint configuration |
| PUT | /dbsettings/endpoints | Update endpoint configurations |
| GET | /dbsettings/whitelistips | Get allowlisted IP addresses |
| POST | /dbsettings/whitelistips | Add allowlisted IP addresses |
| DELETE | /dbsettings/whitelistips | Remove allowlisted IP addresses |
| GET | /metrics/response_time_histograms | Return the histogram of response time for a specified time frame. **DB ADMIN ONLY** |
| GET | /metrics/response_time | Return the list of average response time for a specified time frame. **DB ADMIN ONLY** |