Skip to main content

ML-API

API docs by Redocly

Info API (ALPHA)

Download OpenAPI specification:Download

Implements endpoints reporting the versions and information about of various components of ML APIs.

Additional Documentation

InfoService

Returns details about this instance of ML APIs.

Returns details about this instance of ML APIs.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "commit": "string",
  • "buildTime": "2019-08-24T14:15:22Z",
  • "modules": [
    ]
}

ProjectService

PREVIEW - Returns all Projects owned by authenticated user.

Returns all Projects owned by authenticated user. WIP: Once we have central authz, add filtering, possibly Search method.

Authorizations:
oidc
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "projects": [
    ]
}

PREVIEW - Creates a new project.

Creates a new project.

Authorizations:
oidc
Request Body schema: application/json
required
displayName
string

Required. Immutable. User readable name of the project.

description
string

Optional. Human readable description.

object

Immutable. Annotations assigned. Annotations with ai/h2o/project* prefix are reserved for internal purposes. Annotations with this prefix can be ignored or modified without warning.

status
string (v1alphaProjectStatus)
Enum: "PROJECT_STATUS_AVAILABLE" "PROJECT_STATUS_DELETED"
scheduledDeleteTime
string <date-time>

Optional. Timestamp of the scheduled auto-deletion.

trainingArtifactPurgeEnabled
boolean

Optional. Boolean flag to indicate if the training artifacts purge is enabled.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "status": "PROJECT_STATUS_AVAILABLE",
  • "scheduledDeleteTime": "2019-08-24T14:15:22Z",
  • "trainingArtifactPurgeEnabled": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "status": "PROJECT_STATUS_AVAILABLE",
  • "scheduledDeleteTime": "2019-08-24T14:15:22Z",
  • "trainingArtifactPurgeEnabled": true,
  • "trainingArtifactPurgedTime": "2019-08-24T14:15:22Z"
}

PREVIEW - Returns details of an existing project.

Returns details of an existing project.

Authorizations:
oidc
path Parameters
project
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "status": "PROJECT_STATUS_AVAILABLE",
  • "scheduledDeleteTime": "2019-08-24T14:15:22Z",
  • "trainingArtifactPurgeEnabled": true,
  • "trainingArtifactPurgedTime": "2019-08-24T14:15:22Z"
}

Deletes the Project resource.

Deletes the Project resource. This action is irreversible.

Authorizations:
oidc
path Parameters
project
required
string

Responses

Response samples

Content type
application/json
{ }

PENDING - Updates the Project resource.

Updates the Project resource.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
displayName
string

Required. Immutable. User readable name of the project.

description
string

Optional. Human readable description.

object

Immutable. Annotations assigned. Annotations with ai/h2o/project* prefix are reserved for internal purposes. Annotations with this prefix can be ignored or modified without warning.

status
string (v1alphaProjectStatus)
Enum: "PROJECT_STATUS_AVAILABLE" "PROJECT_STATUS_DELETED"
scheduledDeleteTime
string <date-time>

Optional. Timestamp of the scheduled auto-deletion.

trainingArtifactPurgeEnabled
boolean

Optional. Boolean flag to indicate if the training artifacts purge is enabled.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "status": "PROJECT_STATUS_AVAILABLE",
  • "scheduledDeleteTime": "2019-08-24T14:15:22Z",
  • "trainingArtifactPurgeEnabled": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "status": "PROJECT_STATUS_AVAILABLE",
  • "scheduledDeleteTime": "2019-08-24T14:15:22Z",
  • "trainingArtifactPurgeEnabled": true,
  • "trainingArtifactPurgedTime": "2019-08-24T14:15:22Z"
}

PREVIEW - Triggers the projects scheduled deletion.

Triggers the projects scheduled deletion. This action is irreversible

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{ }

PREVIEW - Triggers the projects training artifact purge.

Triggers the projects training artifact purge. This action is irreversible

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{ }
Feedback