> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # REST API | Feature Name | Description | | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | [/admin/add/host](/content/api/rest/admin_add_host_rest) | Adds a host to the cluster. | | [/admin/add/ranks](/content/api/rest/admin_add_ranks_rest) | Add new ranks to the Kinetica cluster. | | [/admin/alter/host](/content/api/rest/admin_alter_host_rest) | Alter properties on a host currently in the cluster. | | [/admin/alter/jobs](/content/api/rest/admin_alter_jobs_rest) | Alter a job. | | [/admin/backup/begin](/content/api/rest/admin_backup_begin_rest) | Prepares the system for a backup operation. | | [/admin/backup/end](/content/api/rest/admin_backup_end_rest) | End system backup mode. | | [/admin/ha/offline](/content/api/rest/admin_ha_offline_rest) | Pauses consumption of messages from other HA clusters. | | [/admin/ha/refresh](/content/api/rest/admin_ha_refresh_rest) | Restarts HA to handle breaking conf changes. | | [/admin/offline](/content/api/rest/admin_offline_rest) | Take the system offline. | | [/admin/rebalance](/content/api/rest/admin_rebalance_rest) | Rebalance data and/or shards across all nodes in a cluster. | | [/admin/remove/host](/content/api/rest/admin_remove_host_rest) | Removes a host from the cluster. | | [/admin/remove/ranks](/content/api/rest/admin_remove_ranks_rest) | Remove rank(s) from the Kinetica cluster. | | [/admin/repair/table](/content/api/rest/admin_repair_table_rest) | Manually repair a corrupted table. | | [/admin/send/alert](/content/api/rest/admin_send_alert_rest) | Send an alert to the monitoring system. | | [/admin/show/alerts](/content/api/rest/admin_show_alerts_rest) | Show a list of generated alerts. | | [/admin/show/cluster/operations](/content/api/rest/admin_show_cluster_operations_rest) | Show cluster operations (add/remove ranks or rebalance) status. | | [/admin/show/jobs](/content/api/rest/admin_show_jobs_rest) | Show the current jobs in GPUdb. | | [/admin/show/shards](/content/api/rest/admin_show_shards_rest) | Show the mapping of the shards to the ranks. | | [/admin/shutdown](/content/api/rest/admin_shutdown_rest) | Stop the database server application. | | [/admin/switchover](/content/api/rest/admin_switchover_rest) | Manually switch over one or more processes to another host. | | [/admin/verifydb](/content/api/rest/admin_verifydb_rest) | Verify database is in a consistent state. | | [/aggregate/convexhull](/content/api/rest/aggregate_convexhull_rest) | Calculate and return the convex hull for a dataset. | | [/aggregate/groupby](/content/api/rest/aggregate_groupby_rest) | Calculate unique combinations of values for the given columns in a given dataset. | | [/aggregate/histogram](/content/api/rest/aggregate_histogram_rest) | Perform a histogram calculation given a table, column, and interval function. | | [/aggregate/kmeans](/content/api/rest/aggregate_kmeans_rest) | Run the k-means algorithm on a dataset. | | [/aggregate/minmax](/content/api/rest/aggregate_minmax_rest) | Calculate the min and max values of a column in a dataset. | | [/aggregate/minmax/geometry](/content/api/rest/aggregate_minmax_geometry_rest) | Calculate the min and max x- and y- coordinates of a geospatial geometry column in a dataset. | | [/aggregate/statistics](/content/api/rest/aggregate_statistics_rest) | Calculate statistics of a dataset. | | [/aggregate/statistics/byrange](/content/api/rest/aggregate_statistics_byrange_rest) | Divide a dataset into bins and calculate statistics of the values. | | [/aggregate/unique](/content/api/rest/aggregate_unique_rest) | Find unique values in a column. | | [/aggregate/unpivot](/content/api/rest/aggregate_unpivot_rest) | Rotate column values into rows values. | | [/alter/backup](/content/api/rest/alter_backup_rest) | Alter a database backup. | | [/alter/credential](/content/api/rest/alter_credential_rest) | Alter an existing credential. | | [/alter/datasink](/content/api/rest/alter_datasink_rest) | Alter an existing data sink. | | [/alter/datasource](/content/api/rest/alter_datasource_rest) | Alter an existing data source. | | [/alter/directory](/content/api/rest/alter_directory_rest) | Alter an existing directory in KiFS. | | [/alter/environment](/content/api/rest/alter_environment_rest) | Alter an existing UDF environment. | | [/alter/resourcegroup](/content/api/rest/alter_resourcegroup_rest) | Alter an existing resource group. | | [/alter/role](/content/api/rest/alter_role_rest) | Alter a Role. | | [/alter/schema](/content/api/rest/alter_schema_rest) | Alter a SQL-style schema. | | [/alter/system/properties](/content/api/rest/alter_system_properties_rest) | Alter system configuration. | | [/alter/table](/content/api/rest/alter_table_rest) | Modify various properties of a table or view. | | [/alter/table/columns](/content/api/rest/alter_table_columns_rest) | Modify various properties of multiple columns in a table (multiple alter/table requests for columns). | | [/alter/table/metadata](/content/api/rest/alter_table_metadata_rest) | Alter metadata for tables. | | [/alter/tablemonitor](/content/api/rest/alter_tablemonitor_rest) | Alter an existing table monitor. | | [/alter/tier](/content/api/rest/alter_tier_rest) | Alter an existing tier. | | [/alter/user](/content/api/rest/alter_user_rest) | Alter a user. | | [/alter/video](/content/api/rest/alter_video_rest) | Alter a video. | | [/alter/wal](/content/api/rest/alter_wal_rest) | Alters table write-ahead log (WAL) settings. | | [/append/records](/content/api/rest/append_records_rest) | Append records from a source table to a target table based on the field map. | | [/check/table](/content/api/rest/check_table_rest) | Shows information relating corrupt table entries. | | [/clear/statistics](/content/api/rest/clear_statistics_rest) | Clears statistics for column(s) in a table. | | [/clear/table](/content/api/rest/clear_table_rest) | Delete a table. | | [/clear/tablemonitor](/content/api/rest/clear_tablemonitor_rest) | Deactivate a table monitor. | | [/clear/tables](/content/api/rest/clear_tables_rest) | Delete tables. | | [/clear/trigger](/content/api/rest/clear_trigger_rest) | Delete a trigger. | | [/collect/statistics](/content/api/rest/collect_statistics_rest) | Collect statistics on a column. | | [/create/backup](/content/api/rest/create_backup_rest) | Create a database backup. | | [/create/catalog](/content/api/rest/create_catalog_rest) | Create a catalog. | | [/create/credential](/content/api/rest/create_credential_rest) | Create a new credential. | | [/create/datasink](/content/api/rest/create_datasink_rest) | Create a data sink. | | [/create/datasource](/content/api/rest/create_datasource_rest) | Create a data source. | | [/create/directory](/content/api/rest/create_directory_rest) | Create a directory in KiFS. | | [/create/environment](/content/api/rest/create_environment_rest) | Create a UDF environment. | | [/create/graph](/content/api/rest/create_graph_rest) | Create a new graph network. | | [/create/job](/content/api/rest/create_job_rest) | Create a new job to be executed asynchronously. | | [/create/jointable](/content/api/rest/create_jointable_rest) | Create a table that is the result of a SQL JOIN. | | [/create/materializedview](/content/api/rest/create_materializedview_rest) | Begin the creation a materialized view. | | [/create/proc](/content/api/rest/create_proc_rest) | Create a proc. | | [/create/projection](/content/api/rest/create_projection_rest) | Create a projection of an existing table. | | [/create/resourcegroup](/content/api/rest/create_resourcegroup_rest) | Create a new resource group. | | [/create/role](/content/api/rest/create_role_rest) | Create a new role. | | [/create/schema](/content/api/rest/create_schema_rest) | Create a SQL-style schema. | | [/create/table](/content/api/rest/create_table_rest) | Create a new table. | | [/create/table/external](/content/api/rest/create_table_external_rest) | Create a new external table. | | [/create/tablemonitor](/content/api/rest/create_tablemonitor_rest) | Create a table monitor that will watch for and queue any records added. | | [/create/trigger/byarea](/content/api/rest/create_trigger_byarea_rest) | Create a table trigger for new records falling within a 2-D boundary. | | [/create/trigger/byrange](/content/api/rest/create_trigger_byrange_rest) | Create a table trigger for new records falling within a 1-D range. | | [/create/type](/content/api/rest/create_type_rest) | Create a table record type. | | [/create/union](/content/api/rest/create_union_rest) | Create a table that is the merge of one or more tables. | | [/create/user/external](/content/api/rest/create_user_external_rest) | Create a new external user. | | [/create/user/internal](/content/api/rest/create_user_internal_rest) | Create a new internal user. | | [/create/video](/content/api/rest/create_video_rest) | Create a video. | | [/delete/directory](/content/api/rest/delete_directory_rest) | Delete a directory from KiFS. | | [/delete/files](/content/api/rest/delete_files_rest) | Delete one or more files from KiFS. | | [/delete/graph](/content/api/rest/delete_graph_rest) | Deletes a graph. | | [/delete/proc](/content/api/rest/delete_proc_rest) | Delete a proc. | | [/delete/records](/content/api/rest/delete_records_rest) | Delete matching records from a dataset. | | [/delete/resourcegroup](/content/api/rest/delete_resourcegroup_rest) | Deletes a resource group. | | [/delete/role](/content/api/rest/delete_role_rest) | Delete an existing role. | | [/delete/user](/content/api/rest/delete_user_rest) | Delete an existing user. | | [/download/files](/content/api/rest/download_files_rest) | Download one or more files from KiFS. | | [/drop/backup](/content/api/rest/drop_backup_rest) | Deletes a database backup. | | [/drop/catalog](/content/api/rest/drop_catalog_rest) | Drop an existing catalog. | | [/drop/credential](/content/api/rest/drop_credential_rest) | Drop an existing credential. | | [/drop/datasink](/content/api/rest/drop_datasink_rest) | Drop an existing data sink. | | [/drop/datasource](/content/api/rest/drop_datasource_rest) | Drop an existing data source. | | [/drop/environment](/content/api/rest/drop_environment_rest) | Drop an existing UDF environment. | | [/drop/schema](/content/api/rest/drop_schema_rest) | Drop an existing SQL-style schema. | | [/execute/proc](/content/api/rest/execute_proc_rest) | Execute a proc. | | [/execute/sql](/content/api/rest/execute_sql_rest) | Execute a SQL statement (query, DML, or DDL). | | [/export/query/metrics](/content/api/rest/export_query_metrics_rest) | Export query metrics to a given destination. | | [/export/records/tofiles](/content/api/rest/export_records_tofiles_rest) | Export records from table. | | [/export/records/totable](/content/api/rest/export_records_totable_rest) | Exports records from source table to the specified target table in an external database. | | [/filter](/content/api/rest/filter_rest) | Filter a dataset for records matching an expression. | | [/filter/byarea](/content/api/rest/filter_byarea_rest) | Filter a dataset for records falling within a 2-D polygon's boundary. | | [/filter/byarea/geometry](/content/api/rest/filter_byarea_geometry_rest) | Filter a dataset for geospatial geometry objects intersecting a 2-D polygon. | | [/filter/bybox](/content/api/rest/filter_bybox_rest) | Filter a dataset for records within a rectangle's boundary. | | [/filter/bybox/geometry](/content/api/rest/filter_bybox_geometry_rest) | Filter a dataset for geospatial geometry objects intersecting a rectangle's boundary. | | [/filter/bygeometry](/content/api/rest/filter_bygeometry_rest) | Filter a dataset for records in relation to a given WKT geometry's boundary. | | [/filter/bylist](/content/api/rest/filter_bylist_rest) | Filter a dataset for records with specific column values. | | [/filter/byradius](/content/api/rest/filter_byradius_rest) | Filter a dataset for records within a circle's boundary. | | [/filter/byradius/geometry](/content/api/rest/filter_byradius_geometry_rest) | Filter a dataset for geospatial geometry objects intersecting a circle's boundary. | | [/filter/byrange](/content/api/rest/filter_byrange_rest) | Filter a dataset for records within a 1-D range. | | [/filter/byseries](/content/api/rest/filter_byseries_rest) | Filter a dataset for records within a track's space/time boundary. | | [/filter/bystring](/content/api/rest/filter_bystring_rest) | Filter a dataset for records with matching column text values. | | [/filter/bytable](/content/api/rest/filter_bytable_rest) | Filter a dataset for records with column values matching another table's column values. | | [/filter/byvalue](/content/api/rest/filter_byvalue_rest) | Filter a dataset for records matching a specific value. | | [/get/graph/entities](/content/api/rest/get_graph_entities_rest) | Retrieve graph nodes or edges. | | [/get/job](/content/api/rest/get_job_rest) | Get the status and result of asynchronously running job. | | [/get/records](/content/api/rest/get_records_rest) | Retrieve records from a table with optional filtering and sorting. | | [/get/records/bycolumn](/content/api/rest/get_records_bycolumn_rest) | Retrieve the values of the given columns within a specified range. | | [/get/records/byseries](/content/api/rest/get_records_byseries_rest) | Retrieve the complete series/track records from partial track information. | | [/get/records/fromcollection](/content/api/rest/get_records_fromcollection_rest) | \[DEPRECATED] Retrieve records from a collection, optionally returning the record IDs. | | [/get/records/json](/content/api/rest/get_records_json_rest) | Get records in JSON format. | | [/grant/permission](/content/api/rest/grant_permission_rest) | Grant user or role the specified permission on the specified object. | | [/grant/permission/credential](/content/api/rest/grant_permission_credential_rest) | Grant a credential-level permission to a user or role. | | [/grant/permission/datasource](/content/api/rest/grant_permission_datasource_rest) | Grant a data source permission to a user or role. | | [/grant/permission/directory](/content/api/rest/grant_permission_directory_rest) | Grant a KiFS directory-level permission to a user or role. | | [/grant/permission/proc](/content/api/rest/grant_permission_proc_rest) | Grant a proc-level permission to a user or role. | | [/grant/permission/system](/content/api/rest/grant_permission_system_rest) | Grant a system-level permission to a user or role. | | [/grant/permission/table](/content/api/rest/grant_permission_table_rest) | Grant a table-level permission to a user or role. | | [/grant/role](/content/api/rest/grant_role_rest) | Grant membership in a role to a user or role. | | [/has/permission](/content/api/rest/has_permission_rest) | Check if user has specified permission on the specified object. | | [/has/proc](/content/api/rest/has_proc_rest) | Check for existence of specified proc. | | [/has/role](/content/api/rest/has_role_rest) | Check if user has specified role. | | [/has/schema](/content/api/rest/has_schema_rest) | Check for the existence of specified schema. | | [/has/table](/content/api/rest/has_table_rest) | Check for the existence of specified table. | | [/has/type](/content/api/rest/has_type_rest) | Check for the existence of specified type. | | [/insert/records](/content/api/rest/insert_records_rest) | Add records to specified table. | | [/insert/records/fromfiles](/content/api/rest/insert_records_fromfiles_rest) | Insert records from one or more files into the specified target table. | | [/insert/records/frompayload](/content/api/rest/insert_records_frompayload_rest) | Insert records from a text-based or binary payload into the specified target table. | | [/insert/records/fromquery](/content/api/rest/insert_records_fromquery_rest) | Insert records from external database from a given query into the specified target table. | | [/insert/records/json](/content/api/rest/insert_records_json_rest) | Insert records in JSON format. | | [/insert/records/random](/content/api/rest/insert_records_random_rest) | Generate random records and insert into specified table. | | [/insert/symbol](/content/api/rest/insert_symbol_rest) | Add rendering symbol or icon to the database. | | [/kill/proc](/content/api/rest/kill_proc_rest) | Kill a running proc instance. | | [/lock/table](/content/api/rest/lock_table_rest) | Set read or write locks on a table. | | [/match/graph](/content/api/rest/match_graph_rest) | Match sample points to a graph. | | [/modify/graph](/content/api/rest/modify_graph_rest) | Update an existing graph network. | | [/query/graph](/content/api/rest/query_graph_rest) | Queries an existing graph. | | [/repartition/graph](/content/api/rest/repartition_graph_rest) | Rebalance existing partitioned graph network. | | [/restore/backup](/content/api/rest/restore_backup_rest) | Restores a backup. | | [/revoke/permission](/content/api/rest/revoke_permission_rest) | Revoke from user or role the specified permission on the specified object. | | [/revoke/permission/credential](/content/api/rest/revoke_permission_credential_rest) | Revoke a credential-level permission from a user or role. | | [/revoke/permission/datasource](/content/api/rest/revoke_permission_datasource_rest) | Revoke a data source permission from a user or role. | | [/revoke/permission/directory](/content/api/rest/revoke_permission_directory_rest) | Revoke a KiFS directory-level permission from a user or role. | | [/revoke/permission/proc](/content/api/rest/revoke_permission_proc_rest) | Revoke a proc-level permission from a user or role. | | [/revoke/permission/system](/content/api/rest/revoke_permission_system_rest) | Revoke a system-level permission from a user or role. | | [/revoke/permission/table](/content/api/rest/revoke_permission_table_rest) | Revoke a table-level permission from a user or role. | | [/revoke/role](/content/api/rest/revoke_role_rest) | Revoke membership in a role from a user or role. | | [/show/backup](/content/api/rest/show_backup_rest) | Show information about backups. | | [/show/credential](/content/api/rest/show_credential_rest) | Show information about a credential. | | [/show/datasink](/content/api/rest/show_datasink_rest) | Show information about a data sinks. | | [/show/datasource](/content/api/rest/show_datasource_rest) | Show information about a data source. | | [/show/directories](/content/api/rest/show_directories_rest) | Show information about directories in KiFS. | | [/show/environment](/content/api/rest/show_environment_rest) | Show information about a environment. | | [/show/files](/content/api/rest/show_files_rest) | Show information about files in KiFS. | | [/show/graph](/content/api/rest/show_graph_rest) | Show information about graphs. | | [/show/proc](/content/api/rest/show_proc_rest) | Show information about a proc. | | [/show/proc/status](/content/api/rest/show_proc_status_rest) | Show the statuses of running or completed proc instances. | | [/show/resource/objects](/content/api/rest/show_resource_objects_rest) | Shows information relating to resource objects. | | [/show/resource/statistics](/content/api/rest/show_resource_statistics_rest) | Show statistics for tier and resource groups. | | [/show/resourcegroups](/content/api/rest/show_resourcegroups_rest) | Shows information relating to resource groups. | | [/show/schema](/content/api/rest/show_schema_rest) | Show information about a single SQL-style schema or all schemas. | | [/show/security](/content/api/rest/show_security_rest) | Show security information relating to users and/or roles. | | [/show/sql/proc](/content/api/rest/show_sql_proc_rest) | Show information about a SQL Procedure. | | [/show/statistics](/content/api/rest/show_statistics_rest) | Show collected statistics for the specified table. | | [/show/system/properties](/content/api/rest/show_system_properties_rest) | Show the server configuration and version information. | | [/show/system/status](/content/api/rest/show_system_status_rest) | Show server configuration and health status. | | [/show/system/timing](/content/api/rest/show_system_timing_rest) | Show the last 100 requests, the request timing, and internal job ID. | | [/show/table](/content/api/rest/show_table_rest) | Show information about tables, views, or schemas. | | [/show/table/metadata](/content/api/rest/show_table_metadata_rest) | Show metadata for the specified table. | | [/show/tablemonitors](/content/api/rest/show_tablemonitors_rest) | Show information about table monitors. | | [/show/tables/bytype](/content/api/rest/show_tables_bytype_rest) | Show table names of specified type. | | [/show/triggers](/content/api/rest/show_triggers_rest) | Show information for specified or all triggers. | | [/show/types](/content/api/rest/show_types_rest) | Show information for specified types. | | [/show/video](/content/api/rest/show_video_rest) | Retrieve information about rendered videos. | | [/show/wal](/content/api/rest/show_wal_rest) | Shows information relating to table write-ahead log (WAL) entries. | | [/solve/graph](/content/api/rest/solve_graph_rest) | Solves an existing graph. | | [/update/records](/content/api/rest/update_records_rest) | Perform predicate-based updates to table data. | | [/upload/files](/content/api/rest/upload_files_rest) | Upload one or more files to KiFS. | | [/upload/files/fromurl](/content/api/rest/upload_files_fromurl_rest) | Upload one or more files to KiFS from a URL list. | | [/verify/backup](/content/api/rest/verify_backup_rest) | Shows detailed information about corrupt backups. | | [/visualize/image/chart](/content/api/rest/visualize_image_chart_rest) | Draw a chart from specified tables and return it as an image. | | [/visualize/isochrone](/content/api/rest/visualize_isochrone_rest) | Draw isolines for travel results. | | [/vts](/content/api/rest/vts_rest) | VTS capability. | | [/wms](/content/api/rest/wms_rest) | WMS capability. |