[//]: # (Preview with http://jbt.github.io/markdown-editor) # REST API Routes Table of Contents --- HTTP method | URI pattern | Input schema | Output schema | Summary --- | --- | --- | --- | --- POST | /2/CreateFrame | CreateFrameV2 | CreateFrameV2 | Create a synthetic H2O Frame. POST | /2/SplitFrame | SplitFrameV2 | SplitFrameV2 | Split a H2O Frame. POST | /2/MissingInserter | MissingInserterV2 | MissingInserterV2 | Insert missing values. GET | /2/ImportFiles | ImportFilesV2 | ImportFilesV2 | Import raw data files into a single-column H2O Frame. POST | /2/ParseSetup | ParseSetupV2 | ParseSetupV2 | Guess the parameters for parsing raw byte-oriented data into an H2O Frame. POST | /2/Parse | ParseV2 | ParseV2 | Parse a raw byte-oriented Frame into a useful columnar data Frame. GET | /1/Inspect | InspectV1 | InspectV1 | View an arbitrary value from the distributed K/V store. GET | /1/Cloud | CloudV1 | CloudV1 | Determine the status of the nodes in the H2O cloud. HEAD | /1/Cloud | CloudV1 | CloudV1 | Determine the status of the nodes in the H2O cloud. GET | /2/Jobs | JobsV2 | Schema | Get a list of all the H2O Jobs (long-running actions). GET | /2/Timeline | TimelineV2 | TimelineV2 | Something something something. GET | /2/Profiler | ProfilerV2 | ProfilerV2 | Something something something. GET | /2/JStack | JStackV2 | JStackV2 | Something something something. GET | /2/NetworkTest | NetworkTestV2 | NetworkTestV2 | Something something something. GET | /2/UnlockKeys | UnlockKeysV2 | UnlockKeysV2 | Unlock all keys in the H2O distributed K/V store, to attempt to recover from a crash. POST | /2/Shutdown | ShutdownV2 | ShutdownV2 | Shut down the cluster GET | /1/Tutorials | TutorialsV1 | TutorialsV1 | H2O tutorials. GET | / | TutorialsV1 | TutorialsV1 | H2O tutorials. GET | /3/About | AboutV3 | AboutV3 | Return information about this H2O. GET | /1/Metadata/endpoints/{num>[0-9]+) | DocsV1 | DocsV1 | Return the REST API endpoint metadata, including documentation, for the endpoint specified by number. GET | /1/Metadata/endpoints/{path} | DocsV1 | DocsV1 | Return the REST API endpoint metadata, including documentation, for the endpoint specified by path. GET | /1/Metadata/endpoints | DocsV1 | DocsV1 | Return a list of all the REST API endpoints. GET | /1/Metadata/schemaclasses/{classname} | DocsV1 | DocsV1 | Return the REST API schema metadata for specified schema class. GET | /1/Metadata/schemas/{schemaname} | DocsV1 | DocsV1 | Return the REST API schema metadata for specified schema. GET | /1/Metadata/schemas | DocsV1 | DocsV1 | Return list of all REST API schemas. GET | /2/Typeahead/files | TypeaheadV2 | Schema | Typehead hander for filename completion. GET | /2/Jobs/{key} | JobsV2 | Schema | Get the status of the given H2O Job (long-running action). POST | /2/Jobs/{key}/cancel | JobsV2 | Schema | Cancel a running job. GET | /2/Find | FindV2 | FindV2 | Find a value within a Frame. GET | /3/Frames/{key}/columns/{column}/summary | FramesV3 | FramesV3 | Return the summary metrics for a column, e.g. mins, maxes, mean, sigma, percentiles, etc. GET | /3/Frames/{key}/columns/{column}/domain | FramesV3 | FramesV3 | Return the domains for the specified column. "null" if the column is not an Enum. GET | /3/Frames/{key}/columns/{column} | FramesV3 | FramesV3 | Return the specified column from a Frame. GET | /3/Frames/{key}/columns | FramesV3 | FramesV3 | Return all the columns from a Frame. GET | /3/Frames/{key} | FramesV3 | FramesV3 | Return the specified Frame. GET | /3/Frames | FramesV3 | FramesV3 | Return all Frames in the H2O distributed K/V store. GET | /2/Frames | FramesV2 | FramesV2 | Return all Frames in the H2O distributed K/V store (old output format). DELETE | /3/Frames/{key} | FramesV3 | FramesV3 | Delete the specified Frame from the H2O distributed K/V store. DELETE | /3/Frames | FramesV3 | FramesV3 | Delete all Frames from the H2O distributed K/V store. GET | /3/Models/{key} | ModelsV3 | ModelsV3 | Return the specified Model from the H2O distributed K/V store, optionally with the list of compatible Frames. GET | /3/Models | ModelsV3 | ModelsV3 | Return all Models from the H2O distributed K/V store. DELETE | /3/Models/{key} | ModelsV3 | ModelsV3 | Delete the specified Model from the H2O distributed K/V store. DELETE | /3/Models | ModelsV3 | ModelsV3 | Delete all Models from the H2O distributed K/V store. GET | /3/ModelBuilders/{algo} | ModelBuildersV2 | ModelBuildersV2 | Return the Model Builder metadata for the specified algorithm. GET | /3/ModelBuilders | ModelBuildersV2 | ModelBuildersV2 | Return the Model Builder metadata for all available algorithms. GET | /3/ModelMetrics/models/{model}/frames/{frame} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the saved scoring metrics for the specified Model and Frame. DELETE | /3/ModelMetrics/models/{model}/frames/{frame} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the saved scoring metrics for the specified Model and Frame. GET | /3/ModelMetrics/models/{model} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the saved scoring metrics for the specified Model. GET | /3/ModelMetrics/frames/{frame}/models/{model} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the saved scoring metrics for the specified Model and Frame. DELETE | /3/ModelMetrics/frames/{frame}/models/{model} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the saved scoring metrics for the specified Model and Frame. GET | /3/ModelMetrics/frames/{frame} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the saved scoring metrics for the specified Frame. GET | /3/ModelMetrics | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return all the saved scoring metrics. POST | /3/ModelMetrics/models/{model}/frames/{frame} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Return the scoring metrics for the specified Frame with the specified Model. If the Frame has already been scored with the Model then cached results will be returned; otherwise predictions for all rows in the Frame will be generated and the metrics will be returned. POST | /3/Predictions/models/{model}/frames/{frame} | ModelMetricsListSchemaV3 | ModelMetricsListSchemaV3 | Score (generate predictions) for the specified Frame with the specified Model. Both the Frame of predictions and the metrics will be returned. GET | /1/WaterMeterCpuTicks/{nodeidx} | WaterMeterCpuTicksV1 | WaterMeterCpuTicksV1 | Return a CPU usage snapshot of all cores of all nodes in the H2O cluster. POST | /3/NodePersistentStorage/{category}/{name} | NodePersistentStorageV1 | NodePersistentStorageV1 | Store a named value. GET | /3/NodePersistentStorage/{category}/{name} | NodePersistentStorageV1 | NodePersistentStorageV1 | Return value for a given name. DELETE | /3/NodePersistentStorage/{category}/{name} | NodePersistentStorageV1 | NodePersistentStorageV1 | Delete a key. POST | /3/NodePersistentStorage/{category} | NodePersistentStorageV1 | NodePersistentStorageV1 | Store a value. GET | /3/NodePersistentStorage/{category} | NodePersistentStorageV1 | NodePersistentStorageV1 | Return all keys stored for a given category. GET | /3/Logs/nodes/{nodeidx}/files/{name} | LogsV3 | LogsV3 | Get named log file for a node. POST | /1/Rapids | RapidsV1 | RapidsV1 | Something something R exec something. GET | /1/Rapids/isEval | RapidsV1 | RapidsV1 | something something r exec something. GET | /1/DownloadDataset | DownloadDataV1 | DownloadDataV1 | Download something something. DELETE | /1/Remove | RemoveV1 | RemoveV1 | Remove an arbitrary key from the H2O distributed K/V store. DELETE | /1/RemoveAll | RemoveAllV1 | RemoveAllV1 | Remove all keys from the H2O distributed K/V store. POST | /1/LogAndEcho | LogAndEchoV1 | LogAndEchoV1 | Save a message to the H2O logfile. GET | /1/Quantiles | QuantilesV1 | QuantilesV1 | Return quantiles for the specified column of the specified Frame. GET | /1/InitID | InitIDV1 | InitIDV1 | Issue a new session ID. POST | /3/ModelBuilders/gbm | GBMV2 | Schema | Train a GBM model on the specified Frame. POST | /3/ModelBuilders/gbm/parameters | GBMV2 | GBMV2 | Validate a set of GBM model builder parameters. POST | /3/ModelBuilders/kmeans | KMeansV2 | Schema | Train a KMeans model on the specified Frame. POST | /3/ModelBuilders/kmeans/parameters | KMeansV2 | KMeansV2 | Validate a set of KMeans model builder parameters. POST | /3/ModelBuilders/deeplearning | DeepLearningV2 | Schema | Train a Deep Learning model on the specified Frame. POST | /3/ModelBuilders/deeplearning/parameters | DeepLearningV2 | DeepLearningV2 | Validate a set of Deep Learning model builder parameters. POST | /3/ModelBuilders/glm | GLMV2 | Schema | Train a GLM model on the specified Frame. POST | /3/ModelBuilders/glm/parameters | GLMV2 | GLMV2 | Validate a set of GLM model builder parameters. POST | /3/ModelBuilders/pca | PCAV2 | Schema | Train a PCA model on the specified Frame. POST | /3/ModelBuilders/pca/parameters | PCAV2 | PCAV2 | Validate a set of PCA model builder parameters. POST | /3/ModelBuilders/word2vec | Word2VecV2 | Schema | Train a Word2Vec model on the specified Frame. POST | /3/ModelBuilders/word2vec/parameters | Word2VecV2 | Word2VecV2 | Validate a set of Word2Vec model builder parameters. POST | /3/ModelBuilders/example | ExampleV2 | Schema | Train an Example model on the specified Frame. POST | /3/ModelBuilders/example/parameters | ExampleV2 | ExampleV2 | Validate a set of Example model builder parameters. POST | /3/ModelBuilders/quantile | QuantileV2 | Schema | Train a Quantile model on the specified Frame. POST | /3/ModelBuilders/quantile/parameters | QuantileV2 | QuantileV2 | Validate a set of Quantile model builder parameters. POST | /3/ModelBuilders/grep | GrepV2 | Schema | Search a raw text file for matches POST | /3/ModelBuilders/grep/parameters | GrepV2 | GrepV2 | Validate a set of Grep parameters.