Introduction Use the IBM Db2 SaaS API to access data, view and create database objects, administer, and monitor your IBM Db2 SaaS service. These APIs are applicable only for the Perfomance Plan. Java developers can use this SDK to interact with IBM Db2 SaaS. Github
| Method | Path | Summary |
|---|---|---|
| GET | /dbsettings/endpoints | Get the endpoint information |
| PUT | /dbsettings/endpoints | Update service endpoints configuration |
| GET | /dbsettings/whitelistips | Get all the whitelist IPs |
| POST | /dbsettings/whitelistips | Add whitelist IPs |
| DELETE | /dbsettings/whitelistips | Delete whitelist IPs |
| PUT | /access/config/public | Configure public access settings |
| POST | /auth/tokens | Request a new access token |
| GET | /auth/token/publickey | Returns public key of Json Web Token |
| PUT | /auth/password | Sets a new password using dswebToken |
| GET | /backups | Get a list of backups |
| POST | /backups/restore | Restore |
| POST | /backups/backup | Create a backup |
| GET | /backups/setting | Get backup setting |
| POST | /backups/setting | Update backup setting |
| GET | /connectioninfo/{DEPLOYMENT_ID} | Get Db2 connection information |
| POST | /manage/copy_db | Copy database to a new provision database |
| GET | /load_jobs | Lists all data load jobs using 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/{log_path}/log | Downloads log file for a data load job |
| PATCH | /deployments/availability | Converting database availability to Single and High Availability |
| 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 |
| POST | /admin/privileges | Privilege list of selected objects |
| PUT | /admin/privileges | Grant or revoke privileges |
| 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 |
| POST | /admin/privileges/roles | Add new role |
| PUT | /admin/privileges/roles | Grant or revoke the privilges of 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 |
| 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 | /manage/tuneable_param | Get Tuneable Db2 settings |
| POST | /manage/deployments/custom_setting | Change Db2 Settings |
| GET | /db_update | Checks for any available database update |
| POST | /db_update | Trigger database update |
| GET | /manage/dr | List disaster recovery enablement information |
| POST | /manage/dr | Enable disaster recovery |
| GET | /manage/dr/remotes/status | List disaster recovery remotes pair information |
| POST | /manage/dr/takeover | Perform disaster recovery takeover |
| POST | /manage/dr/resync | Resync disaster recovery remote pair |
| GET | /manage/dr/resync/status | Check current disaster recovery resync status |
| POST | /manage/backups/external_backup | Backup database to external storage |
| POST | /backups/external_restore | (Deprecated) Restore to a particular external backup |
| GET | /backups/external_restore/status | (Deprecated) Get the status for the external restore task |
| POST | /backups/external_rollforward | (Deprecated) Rollforward the logs to a external storage |
| DELETE | /home/{path} | Deletes a file in the Db2 temporary cloud object storage |
| GET | /home_content/{path} | Download file from Db2 temporary cloud object storage |
| POST | /home_content/{path} | Uploads a file to Db2 temporary cloud object storage |
| GET | /manage/license/describe | Retrieve detailed license information |
| PUT | /manage/update_db2_licenses | Update DB2 license |
| GET | /monitor/connections | Lists active database connections **DB ADMIN ONLY** |
| DELETE | /monitor/connections/{application_handle} | Terminates a database connection **DB ADMIN ONLY** |
| GET | /metrics/max_connections_count | Get the maximum number of concurrent connections **DB ADMIN ONLY** |
| GET | /metrics/connections_count | Get maximum numbers of concurrent connections. **DB ADMIN ONLY** |
| GET | /metrics/applications/connections | Gets a list of connections |
| GET | /metrics/applications/connections/current/list | Gets a list of current connections |
| GET | /metrics/applications/connections/{application_handle} | Gets a connection detail |
| DELETE | /metrics/applications/connections/{application_handle} | Terminates a database connection **DB ADMIN ONLY** |
| GET | /metrics/applications/connections/{application_handle}/timeseries | Gets a list of timeseries of a connection |
| GET | /metrics/max_cpu | Get the maximum percent of node CPU usage. **DB ADMIN ONLY** |
| GET | /metrics/cpu_summary | Get the percent of node CPU usage. **DB ADMIN ONLY** |
| GET | /metrics/max_lockwaits_rate | Get the maximum lockwaits per minute. **DB ADMIN ONLY** |
| GET | /metrics/lockwaits_rate | Get the maximum lockwaits per minute. **DB ADMIN ONLY** |
| GET | /metrics/max_log_space | Get the maximum usage percentage of logs. **DB ADMIN ONLY** |
| GET | /metrics/log_space | Get the maximum usage percentages of logs. **DB ADMIN ONLY** |
| GET | /metrics/max_memory | Get the maximum percent of node memory usage. **DB ADMIN ONLY** |
| GET | /metrics/memory_summary | Get the percent of node memory usage. **DB ADMIN ONLY** |
| GET | /metrics/response_time_histograms | Get the histogram of response time. **DB ADMIN ONLY** |
| GET | /metrics/average_response_time | Get the average response time. **DB ADMIN ONLY** |
| GET | /metrics/response_time | Get the list of average response time. **DB ADMIN ONLY** |
| GET | /metrics/average_rows_read | Get the average number of rows read(rows/min). **DB ADMIN ONLY** |
| GET | /metrics/rows_read | Get the numbers of rows read(rows/min). **DB ADMIN ONLY** |
| GET | /metrics/statements_count | Get the number of statements. **DB ADMIN ONLY** |
| GET | /metrics/average_statements_rate | Get the average number of statements executed every minutes. **DB ADMIN ONLY** |
| GET | /metrics/statements_rate | Get numbers of statements executed every minutes. **DB ADMIN ONLY** |
| GET | /metrics/statements/inflight_executions | Gets a list of inflight executions |
| GET | /metrics/statements/inflight_executions/current/list | Gets a list of current inflight executions |
| GET | /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id} | Gets a infight execution detail |
| DELETE | /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id} | Terminates a statement **DB ADMIN ONLY** |
| GET | /monitor | Gets overall status of system components |
| GET | /monitor/storage | Gets current storage usage **DB ADMIN ONLY** |
| GET | /monitor/storage/history | Gets 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 | Get the maximum usage percent of storage. **DB ADMIN ONLY** |
| GET | /metrics/storage | Get the usage percent of storage. **DB ADMIN ONLY** |
| GET | /metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries | Get a table storage usage in a time range **DB ADMIN ONLY** |
| GET | /metrics/tables/storage | Gets a list for tables storage **DB ADMIN ONLY** |
| GET | /metrics/schemas/{tabschema}/tables/{tabname}/storage | Gets a table storage **DB ADMIN ONLY** |
| GET | /metrics/storage/schemas | Gets a list for schemas storage **DB ADMIN ONLY** |
| GET | /metrics/storage/schemas/{tabschema}/timeseries | Get a schema used storage in a time range **DB ADMIN ONLY** |
| GET | /metrics/storage/schemas/{tabschema} | Gets a schema storage **DB ADMIN ONLY** |
| POST | /metrics/tables/storage/collector | Runs a tables storage collection **DB ADMIN ONLY** |
| GET | /metrics/schemas | Gets performance metrics for schemas **DB ADMIN ONLY** |
| GET | /metrics/schemas/current/list | Gets performance metrics for schemas **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name} | Gets performance metrics for one schema **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/members | Gets performance metrics on all members for one schema **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/timeseries | Gets performance metrics timeseries for one schema **DB ADMIN ONLY** |
| GET | /metrics/tables | Gets performance of tables **DB ADMIN ONLY** |
| GET | /metrics/tables/current/list | Gets current performance of tables **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/tables/{table_name} | Gets performance of one table **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/tables/{table_name}/members | Gets performance on all members for one table **DB ADMIN ONLY** |
| GET | /metrics/schemas/{schema_name}/tables/{table_name}/timeseries | Gets performance timeseries for one table **DB ADMIN ONLY** |
| GET | /metrics/tableperformance | Gets performance of tables and schemas **DB ADMIN ONLY** |
| GET | /metrics/tableperformance/current/list | Gets current performance of tables and schemas **DB ADMIN ONLY** |
| GET | /metrics/timespent | Get the time spent in each operation. **DB ADMIN ONLY** |
| POST | /manage/backups/new_external_restore | Restore database from external storage |
| GET | /manage/backups/new_external_restore/status/list | Get the list of new external restores |
| POST | /manage/backups/new_external_restore/rollforward | Trigger rollforward from an external restore backup |
| POST | /manage/pausecompute | Pause database resources |
| DELETE | /manage/resumecompute | Resume database resources |
| GET | /manage/pause/status | Get pause status of database resources |
| POST | /scaling/request | Create a scaling request |
| GET | /scaling/resources/info | Get supported scaling ranges and current allocated resources |
| GET | /scaling/history | View scaling history |
| GET | /scaling/instance_type | Get available scaling instance types |
| GET | /scaling/iops_ranges | Get available scaling iops ranges |
| GET | /scaling/mcsp_resources | Get available scaling resources |
| POST | /scaling/mcsp_request | Create a scaling request (old path) |
| 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 | /db2audit/version | Get db2audit version |
| GET | /db2audit/alias | Get db2audit alias |
| POST | /db2audit/install_v3 | Install Db2 Audit Facility V3 |
| GET | /about | Get system information |
| GET | /tasks/status | Get tasks 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** |
| POST | /schema_discovery | Analyzes CSV data to return a list of value data types |