REST API

Feature NameDescription
/admin/add/hostAdds a host to the cluster.
/admin/add/ranksAdd new ranks to the Kinetica cluster.
/admin/alter/hostAlter properties on a host currently in the cluster.
/admin/alter/jobsAlter a job.
/admin/backup/beginPrepares the system for a backup operation.
/admin/backup/endEnd system backup mode.
/admin/ha/offlinePauses consumption of messages from other HA clusters.
/admin/ha/refreshRestarts HA to handle breaking conf changes.
/admin/offlineTake the system offline.
/admin/rebalanceRebalance data and/or shards across all nodes in a cluster.
/admin/remove/hostRemoves a host from the cluster.
/admin/remove/ranksRemove rank(s) from the Kinetica cluster.
/admin/repair/tableManually repair a corrupted table.
/admin/send/alertSend an alert to the monitoring system.
/admin/show/alertsShow a list of generated alerts.
/admin/show/cluster/operationsShow cluster operations (add/remove ranks or rebalance) status.
/admin/show/jobsShow the current jobs in GPUdb.
/admin/show/shardsShow the mapping of the shards to the ranks.
/admin/shutdownStop the database server application.
/admin/switchoverManually switch over one or more processes to another host.
/admin/verifydbVerify database is in a consistent state.
/aggregate/convexhullCalculate and return the convex hull for a dataset.
/aggregate/groupbyCalculate unique combinations of values for the given columns in a given dataset.
/aggregate/histogramPerform a histogram calculation given a table, column, and interval function.
/aggregate/kmeansRun the k-means algorithm on a dataset.
/aggregate/minmaxCalculate the min and max values of a column in a dataset.
/aggregate/minmax/geometryCalculate the min and max x- and y- coordinates of a geospatial geometry column in a dataset.
/aggregate/statisticsCalculate statistics of a dataset.
/aggregate/statistics/byrangeDivide a dataset into bins and calculate statistics of the values.
/aggregate/uniqueFind unique values in a column.
/aggregate/unpivotRotate column values into rows values.
/alter/backupAlter a database backup.
/alter/credentialAlter an existing credential.
/alter/datasinkAlter an existing data sink.
/alter/datasourceAlter an existing data source.
/alter/directoryAlter an existing directory in KiFS.
/alter/environmentAlter an existing UDF environment.
/alter/resourcegroupAlter an existing resource group.
/alter/roleAlter a Role.
/alter/schemaAlter a SQL-style schema.
/alter/system/propertiesAlter system configuration.
/alter/tableModify various properties of a table or view.
/alter/table/columnsModify various properties of multiple columns in a table (multiple alter/table requests for columns).
/alter/table/metadataAlter metadata for tables.
/alter/tablemonitorAlter an existing table monitor.
/alter/tierAlter an existing tier.
/alter/userAlter a user.
/alter/videoAlter a video.
/alter/walAlters table write-ahead log (WAL) settings.
/append/recordsAppend records from a source table to a target table based on the field map.
/check/tableShows information relating corrupt table entries.
/clear/statisticsClears statistics for column(s) in a table.
/clear/tableDelete a table.
/clear/tablemonitorDeactivate a table monitor.
/clear/tablesDelete tables.
/clear/triggerDelete a trigger.
/collect/statisticsCollect statistics on a column.
/create/backupCreate a database backup.
/create/catalogCreate a catalog.
/create/credentialCreate a new credential.
/create/datasinkCreate a data sink.
/create/datasourceCreate a data source.
/create/directoryCreate a directory in KiFS.
/create/environmentCreate a UDF environment.
/create/graphCreate a new graph network.
/create/jobCreate a new job to be executed asynchronously.
/create/jointableCreate a table that is the result of a SQL JOIN.
/create/materializedviewBegin the creation a materialized view.
/create/procCreate a proc.
/create/projectionCreate a projection of an existing table.
/create/resourcegroupCreate a new resource group.
/create/roleCreate a new role.
/create/schemaCreate a SQL-style schema.
/create/tableCreate a new table.
/create/table/externalCreate a new external table.
/create/tablemonitorCreate a table monitor that will watch for and queue any records added.
/create/trigger/byareaCreate a table trigger for new records falling within a 2-D boundary.
/create/trigger/byrangeCreate a table trigger for new records falling within a 1-D range.
/create/typeCreate a table record type.
/create/unionCreate a table that is the merge of one or more tables.
/create/user/externalCreate a new external user.
/create/user/internalCreate a new internal user.
/create/videoCreate a video.
/delete/directoryDelete a directory from KiFS.
/delete/filesDelete one or more files from KiFS.
/delete/graphDeletes a graph.
/delete/procDelete a proc.
/delete/recordsDelete matching records from a dataset.
/delete/resourcegroupDeletes a resource group.
/delete/roleDelete an existing role.
/delete/userDelete an existing user.
/download/filesDownload one or more files from KiFS.
/drop/backupDeletes a database backup.
/drop/catalogDrop an existing catalog.
/drop/credentialDrop an existing credential.
/drop/datasinkDrop an existing data sink.
/drop/datasourceDrop an existing data source.
/drop/environmentDrop an existing UDF environment.
/drop/schemaDrop an existing SQL-style schema.
/execute/procExecute a proc.
/execute/sqlExecute a SQL statement (query, DML, or DDL).
/export/query/metricsExport query metrics to a given destination.
/export/records/tofilesExport records from table.
/export/records/totableExports records from source table to the specified target table in an external database.
/filterFilter a dataset for records matching an expression.
/filter/byareaFilter a dataset for records falling within a 2-D polygon's boundary.
/filter/byarea/geometryFilter a dataset for geospatial geometry objects intersecting a 2-D polygon.
/filter/byboxFilter a dataset for records within a rectangle's boundary.
/filter/bybox/geometryFilter a dataset for geospatial geometry objects intersecting a rectangle's boundary.
/filter/bygeometryFilter a dataset for records in relation to a given WKT geometry's boundary.
/filter/bylistFilter a dataset for records with specific column values.
/filter/byradiusFilter a dataset for records within a circle's boundary.
/filter/byradius/geometryFilter a dataset for geospatial geometry objects intersecting a circle's boundary.
/filter/byrangeFilter a dataset for records within a 1-D range.
/filter/byseriesFilter a dataset for records within a track's space/time boundary.
/filter/bystringFilter a dataset for records with matching column text values.
/filter/bytableFilter a dataset for records with column values matching another table's column values.
/filter/byvalueFilter a dataset for records matching a specific value.
/get/graph/entitiesRetrieve graph nodes or edges.
/get/jobGet the status and result of asynchronously running job.
/get/recordsRetrieve records from a table with optional filtering and sorting.
/get/records/bycolumnRetrieve the values of the given columns within a specified range.
/get/records/byseriesRetrieve the complete series/track records from partial track information.
/get/records/fromcollection[DEPRECATED] Retrieve records from a collection, optionally returning the record IDs.
/get/records/jsonGet records in JSON format.
/grant/permissionGrant user or role the specified permission on the specified object.
/grant/permission/credentialGrant a credential-level permission to a user or role.
/grant/permission/datasourceGrant a data source permission to a user or role.
/grant/permission/directoryGrant a KiFS directory-level permission to a user or role.
/grant/permission/procGrant a proc-level permission to a user or role.
/grant/permission/systemGrant a system-level permission to a user or role.
/grant/permission/tableGrant a table-level permission to a user or role.
/grant/roleGrant membership in a role to a user or role.
/has/permissionCheck if user has specified permission on the specified object.
/has/procCheck for existence of specified proc.
/has/roleCheck if user has specified role.
/has/schemaCheck for the existence of specified schema.
/has/tableCheck for the existence of specified table.
/has/typeCheck for the existence of specified type.
/insert/recordsAdd records to specified table.
/insert/records/fromfilesInsert records from one or more files into the specified target table.
/insert/records/frompayloadInsert records from a text-based or binary payload into the specified target table.
/insert/records/fromqueryInsert records from external database from a given query into the specified target table.
/insert/records/jsonInsert records in JSON format.
/insert/records/randomGenerate random records and insert into specified table.
/insert/symbolAdd rendering symbol or icon to the database.
/kill/procKill a running proc instance.
/lock/tableSet read or write locks on a table.
/match/graphMatch sample points to a graph.
/modify/graphUpdate an existing graph network.
/query/graphQueries an existing graph.
/repartition/graphRebalance existing partitioned graph network.
/restore/backupRestores a backup.
/revoke/permissionRevoke from user or role the specified permission on the specified object.
/revoke/permission/credentialRevoke a credential-level permission from a user or role.
/revoke/permission/datasourceRevoke a data source permission from a user or role.
/revoke/permission/directoryRevoke a KiFS directory-level permission from a user or role.
/revoke/permission/procRevoke a proc-level permission from a user or role.
/revoke/permission/systemRevoke a system-level permission from a user or role.
/revoke/permission/tableRevoke a table-level permission from a user or role.
/revoke/roleRevoke membership in a role from a user or role.
/show/backupShow information about backups.
/show/credentialShow information about a credential.
/show/datasinkShow information about a data sinks.
/show/datasourceShow information about a data source.
/show/directoriesShow information about directories in KiFS.
/show/environmentShow information about a environment.
/show/filesShow information about files in KiFS.
/show/graphShow information about graphs.
/show/procShow information about a proc.
/show/proc/statusShow the statuses of running or completed proc instances.
/show/resource/objectsShows information relating to resource objects.
/show/resource/statisticsShow statistics for tier and resource groups.
/show/resourcegroupsShows information relating to resource groups.
/show/schemaShow information about a single SQL-style schema or all schemas.
/show/securityShow security information relating to users and/or roles.
/show/sql/procShow information about a SQL Procedure.
/show/statisticsShow collected statistics for the specified table.
/show/system/propertiesShow the server configuration and version information.
/show/system/statusShow server configuration and health status.
/show/system/timingShow the last 100 requests, the request timing, and internal job ID.
/show/tableShow information about tables, views, or schemas.
/show/table/metadataShow metadata for the specified table.
/show/tablemonitorsShow information about table monitors.
/show/tables/bytypeShow table names of specified type.
/show/triggersShow information for specified or all triggers.
/show/typesShow information for specified types.
/show/videoRetrieve information about rendered videos.
/show/walShows information relating to table write-ahead log (WAL) entries.
/solve/graphSolves an existing graph.
/update/recordsPerform predicate-based updates to table data.
/upload/filesUpload one or more files to KiFS.
/upload/files/fromurlUpload one or more files to KiFS from a URL list.
/verify/backupShows detailed information about corrupt backups.
/visualize/image/chartDraw a chart from specified tables and return it as an image.
/visualize/isochroneDraw isolines for travel results.
/vtsVTS capability.
/wmsWMS capability.