Cloudera Documentation

mlapiv2/api.proto

CMLService

addGroupToSyncedTeam

Add a cdp group to a synced team


/api/v2/teams/{team_name}/groups

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/teams/{team_name}/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        AddGroupToSyncedTeamRequest body = ; // AddGroupToSyncedTeamRequest | 
        String teamName = teamName_example; // String | team name
        try {
            AddGroupToSyncedTeamResponse result = apiInstance.addGroupToSyncedTeam(body, teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#addGroupToSyncedTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        AddGroupToSyncedTeamRequest body = ; // AddGroupToSyncedTeamRequest | 
        String teamName = teamName_example; // String | team name
        try {
            AddGroupToSyncedTeamResponse result = apiInstance.addGroupToSyncedTeam(body, teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#addGroupToSyncedTeam");
            e.printStackTrace();
        }
    }
}
AddGroupToSyncedTeamRequest *body = ; // 
String *teamName = teamName_example; // team name

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Add a cdp group to a synced team
[apiInstance addGroupToSyncedTeamWith:body
    teamName:teamName
              completionHandler: ^(AddGroupToSyncedTeamResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{AddGroupToSyncedTeamRequest}} 
var teamName = teamName_example; // {{String}} team name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addGroupToSyncedTeam(bodyteamName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addGroupToSyncedTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new AddGroupToSyncedTeamRequest(); // AddGroupToSyncedTeamRequest | 
            var teamName = teamName_example;  // String | team name

            try
            {
                // Add a cdp group to a synced team
                AddGroupToSyncedTeamResponse result = apiInstance.addGroupToSyncedTeam(body, teamName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.addGroupToSyncedTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // AddGroupToSyncedTeamRequest | 
$teamName = teamName_example; // String | team name

try {
    $result = $api_instance->addGroupToSyncedTeam($body, $teamName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->addGroupToSyncedTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::AddGroupToSyncedTeamRequest->new(); # AddGroupToSyncedTeamRequest | 
my $teamName = teamName_example; # String | team name

eval { 
    my $result = $api_instance->addGroupToSyncedTeam(body => $body, teamName => $teamName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->addGroupToSyncedTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # AddGroupToSyncedTeamRequest | 
teamName = teamName_example # String | team name

try: 
    # Add a cdp group to a synced team
    api_response = api_instance.add_group_to_synced_team(body, teamName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->addGroupToSyncedTeam: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
team name
Required
Body parameters
Name Description
body *
Parameters to add a cdp group to a synced team {
team_name:
team name string
group_permission:
{
cn:
permission:
}
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

addProjectCollaborator

Add a project collaborator


/api/v2/projects/{project_id}/collaborators/{username}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/collaborators/{username}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        AddProjectCollaboratorRequest body = ; // AddProjectCollaboratorRequest | 
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            AddProjectCollaboratorResponse result = apiInstance.addProjectCollaborator(body, projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#addProjectCollaborator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        AddProjectCollaboratorRequest body = ; // AddProjectCollaboratorRequest | 
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            AddProjectCollaboratorResponse result = apiInstance.addProjectCollaborator(body, projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#addProjectCollaborator");
            e.printStackTrace();
        }
    }
}
AddProjectCollaboratorRequest *body = ; // 
String *projectId = projectId_example; // The identifier of the project.
String *username = username_example; // The username of the collaborator to add.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Add a project collaborator
[apiInstance addProjectCollaboratorWith:body
    projectId:projectId
    username:username
              completionHandler: ^(AddProjectCollaboratorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{AddProjectCollaboratorRequest}} 
var projectId = projectId_example; // {{String}} The identifier of the project.
var username = username_example; // {{String}} The username of the collaborator to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addProjectCollaborator(bodyprojectIdusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addProjectCollaboratorExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new AddProjectCollaboratorRequest(); // AddProjectCollaboratorRequest | 
            var projectId = projectId_example;  // String | The identifier of the project.
            var username = username_example;  // String | The username of the collaborator to add.

            try
            {
                // Add a project collaborator
                AddProjectCollaboratorResponse result = apiInstance.addProjectCollaborator(body, projectId, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.addProjectCollaborator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // AddProjectCollaboratorRequest | 
$projectId = projectId_example; // String | The identifier of the project.
$username = username_example; // String | The username of the collaborator to add.

try {
    $result = $api_instance->addProjectCollaborator($body, $projectId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->addProjectCollaborator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::AddProjectCollaboratorRequest->new(); # AddProjectCollaboratorRequest | 
my $projectId = projectId_example; # String | The identifier of the project.
my $username = username_example; # String | The username of the collaborator to add.

eval { 
    my $result = $api_instance->addProjectCollaborator(body => $body, projectId => $projectId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->addProjectCollaborator: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # AddProjectCollaboratorRequest | 
projectId = projectId_example # String | The identifier of the project.
username = username_example # String | The username of the collaborator to add.

try: 
    # Add a project collaborator
    api_response = api_instance.add_project_collaborator(body, projectId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->addProjectCollaborator: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project.
Required
username*
String
The username of the collaborator to add.
Required
Body parameters
Name Description
body *
{

Request for adding a project collaborator.

project_id:
string

The identifier of the project.

username:
string

The username of the collaborator to add.

permission:
string

The project permission of the collaborator to set.

}

Responses

Status: 200 - A successful response.

{

Response for adding a project collaborator.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

batchListProjects

Return a list of projects given a list of project IDs. This method will only return projects that the calling user has access to, and can be used in situations where information about a subset of projects (like project names) is needed.


/api/v2/projects/batch

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/batch?project_ids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        array[String] projectIds = ; // array[String] | The list of project IDs to return projects for.
        try {
            BatchListProjectsResponse result = apiInstance.batchListProjects(projectIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#batchListProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        array[String] projectIds = ; // array[String] | The list of project IDs to return projects for.
        try {
            BatchListProjectsResponse result = apiInstance.batchListProjects(projectIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#batchListProjects");
            e.printStackTrace();
        }
    }
}
array[String] *projectIds = ; // The list of project IDs to return projects for. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return a list of projects given a list of project IDs. This method will only return
projects that the calling user has access to, and can be used in situations where
information about a subset of projects (like project names) is needed.
[apiInstance batchListProjectsWith:projectIds
              completionHandler: ^(BatchListProjectsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'projectIds':  // {{array[String]}} The list of project IDs to return projects for.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchListProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class batchListProjectsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectIds = new array[String](); // array[String] | The list of project IDs to return projects for. (optional) 

            try
            {
                // Return a list of projects given a list of project IDs. This method will only return
projects that the calling user has access to, and can be used in situations where
information about a subset of projects (like project names) is needed.
                BatchListProjectsResponse result = apiInstance.batchListProjects(projectIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.batchListProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectIds = ; // array[String] | The list of project IDs to return projects for.

try {
    $result = $api_instance->batchListProjects($projectIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->batchListProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectIds = []; # array[String] | The list of project IDs to return projects for.

eval { 
    my $result = $api_instance->batchListProjects(projectIds => $projectIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->batchListProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectIds =  # array[String] | The list of project IDs to return projects for. (optional)

try: 
    # Return a list of projects given a list of project IDs. This method will only return
projects that the calling user has access to, and can be used in situations where
information about a subset of projects (like project names) is needed.
    api_response = api_instance.batch_list_projects(projectIds=projectIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->batchListProjects: %s\n" % e)

Parameters

Query parameters
Name Description
project_ids
array[String]
The list of project IDs to return projects for.

Responses

Status: 200 - A successful response.

{

Respons object for listing projects given a list of IDs.

projects:
[

The list of projects.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

inherit:
boolean (boolean)

inherit is meant to be used only for teams.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}
]
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createAmp

Create a new amp project.


/api/v2/amps

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/amps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateAmpRequest body = ; // CreateAmpRequest | 
        try {
            Project result = apiInstance.createAmp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createAmp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateAmpRequest body = ; // CreateAmpRequest | 
        try {
            Project result = apiInstance.createAmp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createAmp");
            e.printStackTrace();
        }
    }
}
CreateAmpRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new amp project.
[apiInstance createAmpWith:body
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateAmpRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAmp(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAmpExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateAmpRequest(); // CreateAmpRequest | 

            try
            {
                // Create a new amp project.
                Project result = apiInstance.createAmp(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createAmp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateAmpRequest | 

try {
    $result = $api_instance->createAmp($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createAmp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateAmpRequest->new(); # CreateAmpRequest | 

eval { 
    my $result = $api_instance->createAmp(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createAmp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateAmpRequest | 

try: 
    # Create a new amp project.
    api_response = api_instance.create_amp(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createAmp: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to create a new AMP (Accelerators for ML Projects).

create_project_request:
{

Parameters to create a new project.

name:
description:
visibility:
parent_project:
git_url:
template:
organization_permission:
default_project_engine_type:
environment:
shared_memory_limit:
team_name:
git_ref:
}
configure_prototype_request:
{

Parameters to configure prootype(Accelerators for ML Projects).

is_huggingface_space:
is_community:
execute_amp_steps:
runtime_identifier:
runtime_addon_identifiers:
run_import_tasks:
}
}

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

inherit:
boolean (boolean)

inherit is meant to be used only for teams.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createApplication

Create an application and implicitly start it immediately.


/api/v2/projects/{project_id}/applications

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateApplicationRequest body = ; // CreateApplicationRequest | 
        String projectId = projectId_example; // String | The project's identifier
        try {
            Application result = apiInstance.createApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateApplicationRequest body = ; // CreateApplicationRequest | 
        String projectId = projectId_example; // String | The project's identifier
        try {
            Application result = apiInstance.createApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createApplication");
            e.printStackTrace();
        }
    }
}
CreateApplicationRequest *body = ; // 
String *projectId = projectId_example; // The project's identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create an application and implicitly start it immediately.
[apiInstance createApplicationWith:body
    projectId:projectId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateApplicationRequest}} 
var projectId = projectId_example; // {{String}} The project's identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApplication(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateApplicationRequest(); // CreateApplicationRequest | 
            var projectId = projectId_example;  // String | The project's identifier

            try
            {
                // Create an application and implicitly start it immediately.
                Application result = apiInstance.createApplication(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateApplicationRequest | 
$projectId = projectId_example; // String | The project's identifier

try {
    $result = $api_instance->createApplication($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateApplicationRequest->new(); # CreateApplicationRequest | 
my $projectId = projectId_example; # String | The project's identifier

eval { 
    my $result = $api_instance->createApplication(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateApplicationRequest | 
projectId = projectId_example # String | The project's identifier

try: 
    # Create an application and implicitly start it immediately.
    api_response = api_instance.create_application(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Body parameters
Name Description
body *
{

Parameters to create an applications.

project_id:
The project's identifier string
name:
string

Name of the new application.

subdomain:
The subdomain of the application. The application will be served at the URL http(s)://subdomain. string
description:
string

The description of the application.

script:
string

The script to run for the new application.

cpu:
number (double)

CPU cores to allocate to application (default 1).

memory:
number (double)

Memory in GB to allocate to application (default 1).

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this application (default 0).

environment:
{

Default environment variables to include in application.

}
kernel:
string

Kernel to run the job runs on. Possible values are python3, python2, r, or scala. Leave blank for runtimes.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
runtime_identifier:
string

Runtime image identifier to run the application with.

runtime_addon_identifiers:
[

Runtime addons to run the application with if using runtimes.

string
]
run_as:
integer (int32)

UserID of service account used to run the application.

cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createCopilotEmbeddingModel

Create a Copilot embedding model.


/api/v2/copilot/embedding_models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/embedding_models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateCopilotEmbeddingModelRequest body = ; // CreateCopilotEmbeddingModelRequest | 
        try {
            CopilotEmbeddingModel result = apiInstance.createCopilotEmbeddingModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateCopilotEmbeddingModelRequest body = ; // CreateCopilotEmbeddingModelRequest | 
        try {
            CopilotEmbeddingModel result = apiInstance.createCopilotEmbeddingModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
CreateCopilotEmbeddingModelRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a Copilot embedding model.
[apiInstance createCopilotEmbeddingModelWith:body
              completionHandler: ^(CopilotEmbeddingModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateCopilotEmbeddingModelRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCopilotEmbeddingModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCopilotEmbeddingModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateCopilotEmbeddingModelRequest(); // CreateCopilotEmbeddingModelRequest | 

            try
            {
                // Create a Copilot embedding model.
                CopilotEmbeddingModel result = apiInstance.createCopilotEmbeddingModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createCopilotEmbeddingModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateCopilotEmbeddingModelRequest | 

try {
    $result = $api_instance->createCopilotEmbeddingModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createCopilotEmbeddingModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateCopilotEmbeddingModelRequest->new(); # CreateCopilotEmbeddingModelRequest | 

eval { 
    my $result = $api_instance->createCopilotEmbeddingModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createCopilotEmbeddingModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateCopilotEmbeddingModelRequest | 

try: 
    # Create a Copilot embedding model.
    api_response = api_instance.create_copilot_embedding_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createCopilotEmbeddingModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters for creating a Copilot embedding model.

provider:
Name of the model provider. E.g. 'Amazon Bedrock' string
name:
string

Name of the embedding model. E.g. 'Llama2 70b'.

endpoint:
string

For CMLServing models, the model endpoint.

enabled:
boolean (boolean)

Whether or not to enable this embedding model for use in Copilot.

default:
boolean (boolean)

Whether to make this the default Copilot embedding model. If set to true, the existing default Copilot model will no longer be default, and this one will become the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Responses

Status: 200 - A successful response.

Copilot Embedding Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createCopilotModel

Create a Copilot model.


/api/v2/copilot/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateCopilotModelRequest body = ; // CreateCopilotModelRequest | 
        try {
            CopilotModel result = apiInstance.createCopilotModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateCopilotModelRequest body = ; // CreateCopilotModelRequest | 
        try {
            CopilotModel result = apiInstance.createCopilotModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createCopilotModel");
            e.printStackTrace();
        }
    }
}
CreateCopilotModelRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a Copilot model.
[apiInstance createCopilotModelWith:body
              completionHandler: ^(CopilotModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateCopilotModelRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCopilotModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCopilotModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateCopilotModelRequest(); // CreateCopilotModelRequest | 

            try
            {
                // Create a Copilot model.
                CopilotModel result = apiInstance.createCopilotModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createCopilotModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateCopilotModelRequest | 

try {
    $result = $api_instance->createCopilotModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createCopilotModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateCopilotModelRequest->new(); # CreateCopilotModelRequest | 

eval { 
    my $result = $api_instance->createCopilotModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createCopilotModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateCopilotModelRequest | 

try: 
    # Create a Copilot model.
    api_response = api_instance.create_copilot_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createCopilotModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters for creating a Copilot model.

provider:
Name of the model provider. E.g. 'Amazon Bedrock' string
name:
string

Name of the model. E.g. 'Llama2 70b'.

endpoint:
string

For CMLServing models, the model endpoint.

enabled:
boolean (boolean)

Whether or not to enable this model for use in Copilot.

default:
boolean (boolean)

Whether to make this the default Copilot model. If set to true, the existing default Copilot model will no longer be default, and this one will become the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Responses

Status: 200 - A successful response.

Copilot Language Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createDockerCredential

Create a Docker credential.


/api/v2/dockercredentials

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/dockercredentials"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateDockerCredentialRequest body = ; // CreateDockerCredentialRequest | 
        try {
            DockerCredentialPublic result = apiInstance.createDockerCredential(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createDockerCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateDockerCredentialRequest body = ; // CreateDockerCredentialRequest | 
        try {
            DockerCredentialPublic result = apiInstance.createDockerCredential(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createDockerCredential");
            e.printStackTrace();
        }
    }
}
CreateDockerCredentialRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a Docker credential.
[apiInstance createDockerCredentialWith:body
              completionHandler: ^(DockerCredentialPublic output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateDockerCredentialRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDockerCredential(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDockerCredentialExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateDockerCredentialRequest(); // CreateDockerCredentialRequest | 

            try
            {
                // Create a Docker credential.
                DockerCredentialPublic result = apiInstance.createDockerCredential(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createDockerCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateDockerCredentialRequest | 

try {
    $result = $api_instance->createDockerCredential($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createDockerCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateDockerCredentialRequest->new(); # CreateDockerCredentialRequest | 

eval { 
    my $result = $api_instance->createDockerCredential(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createDockerCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateDockerCredentialRequest | 

try: 
    # Create a Docker credential.
    api_response = api_instance.create_docker_credential(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createDockerCredential: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

For the use-casaes of creating a docker credential, we need to have an object that contains the sensitive fields but not the ID.

name:
string
server:
string
username:
string
password:
string
is_default:
boolean (boolean)
}

Responses

Status: 200 - A successful response.

{

List* type API calls should not respond with sensitive data, such as username or password. Therefore these API calls will return with this message.

id:
string
name:
string
server:
string
is_default:
boolean (boolean)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createExperiment

Create an experiment.


/api/v2/projects/{project_id}/experiments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRequest body = ; // CreateExperimentRequest | 
        String projectId = projectId_example; // String | 
        try {
            Experiment result = apiInstance.createExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRequest body = ; // CreateExperimentRequest | 
        String projectId = projectId_example; // String | 
        try {
            Experiment result = apiInstance.createExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperiment");
            e.printStackTrace();
        }
    }
}
CreateExperimentRequest *body = ; // 
String *projectId = projectId_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create an experiment.
[apiInstance createExperimentWith:body
    projectId:projectId
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateExperimentRequest}} 
var projectId = projectId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExperiment(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateExperimentRequest(); // CreateExperimentRequest | 
            var projectId = projectId_example;  // String | 

            try
            {
                // Create an experiment.
                Experiment result = apiInstance.createExperiment(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateExperimentRequest | 
$projectId = projectId_example; // String | 

try {
    $result = $api_instance->createExperiment($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateExperimentRequest->new(); # CreateExperimentRequest | 
my $projectId = projectId_example; # String | 

eval { 
    my $result = $api_instance->createExperiment(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateExperimentRequest | 
projectId = projectId_example # String | 

try: 
    # Create an experiment.
    api_response = api_instance.create_experiment(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Body parameters
Name Description
body *
{

CreateExperimentRequest takes the project id and Experiment name.

project_id:
string
name:
Experiment name string
tags:
Tags to add more metadata to experiment[
{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
artifact_location:
string

Location where all artifacts for the experiment are stored. URI of the directory where artifacts should be uploaded. This can be a local path (starting with "/"), or a distributed file system (DFS) path, like s3://bucket/directory or dbfs:/my/directory. If not set, the local ./mlruns directory is chosen.

engine_id:
Engine ID (from session) string
}

Responses

Status: 200 - A successful response.

{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createExperimentRun

Create a run for an experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRunRequest body = ; // CreateExperimentRunRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            ExperimentRun result = apiInstance.createExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRunRequest body = ; // CreateExperimentRunRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            ExperimentRun result = apiInstance.createExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperimentRun");
            e.printStackTrace();
        }
    }
}
CreateExperimentRunRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a run for an experiment.
[apiInstance createExperimentRunWith:body
    projectId:projectId
    experimentId:experimentId
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateExperimentRunRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExperimentRun(bodyprojectIdexperimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateExperimentRunRequest(); // CreateExperimentRunRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.

            try
            {
                // Create a run for an experiment.
                ExperimentRun result = apiInstance.createExperimentRun(body, projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateExperimentRunRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.

try {
    $result = $api_instance->createExperimentRun($body, $projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateExperimentRunRequest->new(); # CreateExperimentRunRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.

eval { 
    my $result = $api_instance->createExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateExperimentRunRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.

try: 
    # Create a run for an experiment.
    api_response = api_instance.create_experiment_run(body, projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required
Body parameters
Name Description
body *
{

CreateExperimentRunRequest takes an experiment id and project id and creates an ExperimentRun entry.

project_id:
string
experiment_id:
string

ID of the associated experiment.

tags:
[

Additional metadata for ExperimentRun.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}

Responses

Status: 200 - A successful response.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location (relative to the experiment run's root artifact directory) and metadata for artifacts.

{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}
]
registered_model_metadata:
[

RegisteredModelMetadata is used to show what model version is registered for this model.

{

RegisteredModelMetadata is used to represent model version metadata.

model_path:
string

model_path artifact folder name.

model_name:
string

model_name.

model_id:
string

model_id of the registered model id.

model_version_id:
string

model_version_id of the.

version_number:
integer (int32)

count of the model version.

run_id:
string

run_id of the experiment run.

created_at:
string (date-time)

created_at timestamp of model registered.

}
]
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createJob

Create a new job.


/api/v2/projects/{project_id}/jobs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRequest body = ; // CreateJobRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        try {
            Job result = apiInstance.createJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRequest body = ; // CreateJobRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        try {
            Job result = apiInstance.createJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJob");
            e.printStackTrace();
        }
    }
}
CreateJobRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the job.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new job.
[apiInstance createJobWith:body
    projectId:projectId
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateJobRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the job.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJob(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateJobRequest(); // CreateJobRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the job.

            try
            {
                // Create a new job.
                Job result = apiInstance.createJob(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateJobRequest | 
$projectId = projectId_example; // String | ID of the project containing the job.

try {
    $result = $api_instance->createJob($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateJobRequest->new(); # CreateJobRequest | 
my $projectId = projectId_example; # String | ID of the project containing the job.

eval { 
    my $result = $api_instance->createJob(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateJobRequest | 
projectId = projectId_example # String | ID of the project containing the job.

try: 
    # Create a new job.
    api_response = api_instance.create_job(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
Body parameters
Name Description
body *
{

Parameters to create a new job.

project_id:
string

ID of the project containing the job.

name:
string

Name of the new job.

script:
string

The script to run for the new job.

cpu:
number (double)

CPU cores to allocate to job runs for this job (default 1).

memory:
number (double)

Memory in GB to allocate to job runs for this job (default 1).

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this job (default 0).

parent_job_id:
Optional dependent job if this new job is a dependency. Setting this to a parent job will make this job run when the parent job completes. Cannot be used alongside "schedule". this is deprecated and alias of parent_id string
environment:
{

Default environment variables to include in job runs for this job.

}
arguments:
Default arguments to pass to job runs for this job string
timeout:
integer (int32)

Timeout in seconds of job runs for this job.

schedule:
string

Schedule to run a job automatically. Cannot be used in a dependency job. Follows the cron format. For example, to execute the job every Monday at 1 PM UTC, the schedule would be "0 13 1" without quotes.

kernel:
string

Kernel to run the job runs on. Possible values are python3, python2, r, or scala. Should not be set if the project uses ML Runtimes.

recipients:
[

An optional list of recipients to receive notifications for job events such as successful runs, failures, and manual stops.

Recipients of a job {
email:
Recipient's email string
notify_on_success:
boolean (boolean)

Whether to notify on job success.

notify_on_failure:
boolean (boolean)

Whether to notify on job failure.

notify_on_timeout:
boolean (boolean)

Whether to notify on job timeout.

notify_on_stop:
boolean (boolean)

Whether to notify when the job is stopped.

}
]
attachments:
[

Files to attach (with path relative to /home/cdsw/) in notification emails. For example, to attach a file located at /home/cdsw/report/result.csv, include "report/result.csv" in the array for this field.

string
]
runtime_identifier:
string

The runtime image identifier to use if this job is part of a ML Runtime project. Must be set if using ML Runtimes.

runtime_addon_identifiers:
[

A list of runtime addon identifiers associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill the job on timeout. This field does nothing if the timeout is not set.

timezone:
string

Timezone of the job. Relevant only when schedule (recurring jobs) is provided (default 'America/Los_Angeles').

paused:
boolean (boolean)

Whether to create the job in paused state. Relevant only when schedule (recurring jobs) is provided. Recurring jobs are put in un-paused state by default.

parent_id:
string

Optional dependent job if this new job is a dependency. Setting this to a parent job will make this job run when the parent job completes. Cannot be used alongside "schedule".

success_recipients:
recipients that are notified when job succeeds string
failure_recipients:
recipients that are notified on when job fails string
timeout_recipients:
recipients that are notified when job times out string
stopped_recipients:
recipients that are notified when job stops string
run_as:
userID of the service account user defaults to userID of the creator integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Responses

Status: 200 - A successful response.

{

One Job.

id:
string

Public identifier of the job. Output only.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created. Output only.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes. Output only.

english_schedule:
string

English schedule. Output only.

arguments:
string

Arguments to the job.

type:
string

Type of job, whether it's "manual", "cron", or "dependent" Output only.

kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused. Output only.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job if this is a scheduled job. Output only.

updated_at:
string (date-time)

When the job was last updated. Output only.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
string

The runtime image identifier if this is a runtime job. Will be blank if using engines.

runtime_addon_identifiers:
[

The runtime addons associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill this job when it times out.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createJobRun

Create and start a new job run for a job.


/api/v2/projects/{project_id}/jobs/{job_id}/runs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRunRequest body = ; // CreateJobRunRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | The job ID to create a new job run for.
        try {
            JobRun result = apiInstance.createJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRunRequest body = ; // CreateJobRunRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | The job ID to create a new job run for.
        try {
            JobRun result = apiInstance.createJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJobRun");
            e.printStackTrace();
        }
    }
}
CreateJobRunRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // The job ID to create a new job run for.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create and start a new job run for a job.
[apiInstance createJobRunWith:body
    projectId:projectId
    jobId:jobId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateJobRunRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} The job ID to create a new job run for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJobRun(bodyprojectIdjobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJobRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateJobRunRequest(); // CreateJobRunRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | The job ID to create a new job run for.

            try
            {
                // Create and start a new job run for a job.
                JobRun result = apiInstance.createJobRun(body, projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateJobRunRequest | 
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | The job ID to create a new job run for.

try {
    $result = $api_instance->createJobRun($body, $projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateJobRunRequest->new(); # CreateJobRunRequest | 
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | The job ID to create a new job run for.

eval { 
    my $result = $api_instance->createJobRun(body => $body, projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateJobRunRequest | 
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | The job ID to create a new job run for.

try: 
    # Create and start a new job run for a job.
    api_response = api_instance.create_job_run(body, projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
The job ID to create a new job run for.
Required
Body parameters
Name Description
body *
{

Parameters to create a new job run.

project_id:
string

ID of the project containing the job.

job_id:
string

The job ID to create a new job run for.

environment:
{

The environment variables to include in this run.

}
arguments:
The arguments to pass to this job run string
}

Responses

Status: 200 - A successful response.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createModel

Create a model.


/api/v2/projects/{project_id}/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelRequest body = ; // CreateModelRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        try {
            Model result = apiInstance.createModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelRequest body = ; // CreateModelRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        try {
            Model result = apiInstance.createModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModel");
            e.printStackTrace();
        }
    }
}
CreateModelRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a model.
[apiInstance createModelWith:body
    projectId:projectId
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModel(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelRequest(); // CreateModelRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model.

            try
            {
                // Create a model.
                Model result = apiInstance.createModel(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelRequest | 
$projectId = projectId_example; // String | ID of the project containing the model.

try {
    $result = $api_instance->createModel($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelRequest->new(); # CreateModelRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model.

eval { 
    my $result = $api_instance->createModel(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateModelRequest | 
projectId = projectId_example # String | ID of the project containing the model.

try: 
    # Create a model.
    api_response = api_instance.create_model(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
Body parameters
Name Description
body *
{

Parameters for creating a model.

project_id:
string

ID of the project containing the model.

name:
string

Name of the model.

description:
string

Description of the model.

disable_authentication:
boolean (boolean)

Whether to disable authentication for requests to deployments of this model.

registered_model_id:
string

Registered Model ID.

run_as:
optional userID of the service account to create/deploy the model when not passed, creator's userID will be used to create/deploy the model integer (int32)
visibility:
string

Visibility of the model.

auto_build_config:
{

Abbreviated createModelBuild information.

comment:
file_path:
function_name:
kernel:
runtime_identifier:
runtime_addon_identifiers:
registered_model_version_id:
}
auto_deployment_config:
{

Abbreviated createModelDeployment information.

cpu:
memory:
nvidia_gpus:
environment:
replicas:
}
auto_build_model:
build the model after successful creation boolean (boolean)
auto_deploy_model:
deploy the model after successful creation and build. Only relevant when auto_build_model = true boolean (boolean)
accelerator_label_id:
string (int64)
}

Responses

Status: 200 - A successful response.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
registered_model_id:
string

Registered Model ID reference to model Regisry.

visibility:
string

Visibility of the model.

default_resources:
Details of a model's default resources {
cpu_millicores:
New number of cpu millicores for the model string (int64)
memory_mb:
New number of memory (in MB) for the model string (int64)
nvidia_gpus:
New number of Nvidia GPUs for the model string (int64)
}
default_replication_policy:
Details of a model's default replication policy {
num_replicas:
Number of replicas to use for the model string (int64)
type:
Type of replication to use (i.e. fixed) string
}
run_as:
userID of the service account that should be used to create/deploy the model When it is empty, creator's userID is used integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createModelBuild

Create a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelBuildRequest body = ; // CreateModelBuildRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model build.
        String modelId = modelId_example; // String | The ID of the model that will the build.
        try {
            ModelBuild result = apiInstance.createModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelBuildRequest body = ; // CreateModelBuildRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model build.
        String modelId = modelId_example; // String | The ID of the model that will the build.
        try {
            ModelBuild result = apiInstance.createModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelBuild");
            e.printStackTrace();
        }
    }
}
CreateModelBuildRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model build.
String *modelId = modelId_example; // The ID of the model that will the build.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a model build.
[apiInstance createModelBuildWith:body
    projectId:projectId
    modelId:modelId
              completionHandler: ^(ModelBuild output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelBuildRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model build.
var modelId = modelId_example; // {{String}} The ID of the model that will the build.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModelBuild(bodyprojectIdmodelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createModelBuildExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelBuildRequest(); // CreateModelBuildRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model build.
            var modelId = modelId_example;  // String | The ID of the model that will the build.

            try
            {
                // Create a model build.
                ModelBuild result = apiInstance.createModelBuild(body, projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelBuildRequest | 
$projectId = projectId_example; // String | ID of the project containing the model build.
$modelId = modelId_example; // String | The ID of the model that will the build.

try {
    $result = $api_instance->createModelBuild($body, $projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createModelBuild: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelBuildRequest->new(); # CreateModelBuildRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model build.
my $modelId = modelId_example; # String | The ID of the model that will the build.

eval { 
    my $result = $api_instance->createModelBuild(body => $body, projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createModelBuild: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateModelBuildRequest | 
projectId = projectId_example # String | ID of the project containing the model build.
modelId = modelId_example # String | The ID of the model that will the build.

try: 
    # Create a model build.
    api_response = api_instance.create_model_build(body, projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model build.
Required
model_id*
String
The ID of the model that will the build.
Required
Body parameters
Name Description
body *
{
project_id:
string

ID of the project containing the model build.

model_id:
string

The ID of the model that will the build.

comment:
string

A comment associated with the build.

file_path:
string

The path to the file to build.

function_name:
string

The function name to run when executing the build.

kernel:
string

The kernel the model build should use.

runtime_identifier:
string

The runtime ID the model build should use.

runtime_addon_identifiers:
[

The runtime addons the model build should use, if using runtimes.

string
]
registered_model_version_id:
string

ID of the registered model version.

auto_deployment_config:
{

Abbreviated createModelDeployment information.

cpu:
memory:
nvidia_gpus:
environment:
replicas:
}
auto_deploy_model:
deploy the model after successful build boolean (boolean)
}

Responses

Status: 200 - A successful response.

{

A single model build.

id:
string

ID of the model build.

model_id:
string

ID of the model containing the build.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
comment:
string

The comment associated with the build.

file_path:
string

Path from the project root to the file to build.

function_name:
string

Name of the function to run.

engine_image:
string

The engine image to build the model with.

kernel:
string

The kernel to run the build with.

created_at:
string (date-time)

When the model build was created.

updated_at:
string (date-time)

When the model build was most recently updated.

status:
string

Status of the build.

deletion_status:
string

State of the deletion of the build.

crn:
string

CRN of the build.

built_at:
string (date-time)

When the model build was most recently updated.

runtime_identifier:
string

Runtime identifier if this model uses runtimes.

runtime_addon_identifiers:
[

Runtime addons if this model uses runtimes.

string
]
registered_model_version_id:
string

ID of the registered model version.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createModelDeployment

Create a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelDeploymentRequest body = ; // CreateModelDeploymentRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to deploy.
        String buildId = buildId_example; // String | ID of the model build to deploy.
        try {
            ModelDeployment result = apiInstance.createModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelDeploymentRequest body = ; // CreateModelDeploymentRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to deploy.
        String buildId = buildId_example; // String | ID of the model build to deploy.
        try {
            ModelDeployment result = apiInstance.createModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelDeployment");
            e.printStackTrace();
        }
    }
}
CreateModelDeploymentRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to deploy.
String *buildId = buildId_example; // ID of the model build to deploy.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a model deployment.
[apiInstance createModelDeploymentWith:body
    projectId:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelDeploymentRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to deploy.
var buildId = buildId_example; // {{String}} ID of the model build to deploy.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModelDeployment(bodyprojectIdmodelIdbuildId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelDeploymentRequest(); // CreateModelDeploymentRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to deploy.
            var buildId = buildId_example;  // String | ID of the model build to deploy.

            try
            {
                // Create a model deployment.
                ModelDeployment result = apiInstance.createModelDeployment(body, projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelDeploymentRequest | 
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to deploy.
$buildId = buildId_example; // String | ID of the model build to deploy.

try {
    $result = $api_instance->createModelDeployment($body, $projectId, $modelId, $buildId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelDeploymentRequest->new(); # CreateModelDeploymentRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to deploy.
my $buildId = buildId_example; # String | ID of the model build to deploy.

eval { 
    my $result = $api_instance->createModelDeployment(body => $body, projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateModelDeploymentRequest | 
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to deploy.
buildId = buildId_example # String | ID of the model build to deploy.

try: 
    # Create a model deployment.
    api_response = api_instance.create_model_deployment(body, projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to deploy.
Required
build_id*
String
ID of the model build to deploy.
Required
Body parameters
Name Description
body *
{

Request for creating a model deployment.

project_id:
string

ID of the project containing the model.

model_id:
string

ID of the model to deploy.

build_id:
string

ID of the model build to deploy.

cpu:
number (double)

Number of vCPU to allocate to the deployment.

memory:
number (double)

Amount of memory in GB to allocate to the deployment.

nvidia_gpus:
integer (int32)

Number of nvidia GPUs to allocate to the deployment.

environment:
{

Environment variables to run the deployment with.

}
replicas:
integer (int32)

Number of Replications.

}

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

replicas:
integer (int32)

Number of Replicas.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createProject

Create a new project.


/api/v2/projects

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateProjectRequest body = ; // CreateProjectRequest | 
        try {
            Project result = apiInstance.createProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateProjectRequest body = ; // CreateProjectRequest | 
        try {
            Project result = apiInstance.createProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createProject");
            e.printStackTrace();
        }
    }
}
CreateProjectRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new project.
[apiInstance createProjectWith:body
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateProjectRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateProjectRequest(); // CreateProjectRequest | 

            try
            {
                // Create a new project.
                Project result = apiInstance.createProject(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateProjectRequest | 

try {
    $result = $api_instance->createProject($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateProjectRequest->new(); # CreateProjectRequest | 

eval { 
    my $result = $api_instance->createProject(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateProjectRequest | 

try: 
    # Create a new project.
    api_response = api_instance.create_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to create a new project.

name:
string

The name of the project to create.

description:
string

The description of the project.

visibility:
string

The visibility of the project (one of "public", "organization", "private"). Default is private.

parent_project:
string

Optional parent project to fork.

git_url:
string

Optional git URL to checkout for this project.

template:
string

Optional template to use (Python, R, PySpark, Scala, Churn Predictor) Note: local will create the project but nothing else, files must be uploaded separately.

organization_permission:
string

If this is an organization-wide project, the visibility to others in the organization.

default_project_engine_type:
string

Whether this project uses legacy engines or runtimes. Valid values are "ml_runtime", "legacy_engine", or leave blank to default to the site-wide default.

environment:
The default set of environment variables to run {
}
shared_memory_limit:
integer (int32)

Additional shared memory limit that engines in this project should have, in MB (default 64).

team_name:
pass value of team name if the owner of this new project should be a team and not a user invoker of the request should either be a member of that team or an admin string
git_ref:
string

Optional git ref to checkout for this project.

}

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

inherit:
boolean (boolean)

inherit is meant to be used only for teams.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createRegisteredModel

Register a model.


/api/v2/registry/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/registry/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRegisteredModelRequest body = ; // CreateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.createRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRegisteredModelRequest body = ; // CreateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.createRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRegisteredModel");
            e.printStackTrace();
        }
    }
}
CreateRegisteredModelRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Register a model.
[apiInstance createRegisteredModelWith:body
              completionHandler: ^(RegisteredModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateRegisteredModelRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRegisteredModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateRegisteredModelRequest(); // CreateRegisteredModelRequest | 

            try
            {
                // Register a model.
                RegisteredModel result = apiInstance.createRegisteredModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateRegisteredModelRequest | 

try {
    $result = $api_instance->createRegisteredModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateRegisteredModelRequest->new(); # CreateRegisteredModelRequest | 

eval { 
    my $result = $api_instance->createRegisteredModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateRegisteredModelRequest | 

try: 
    # Register a model.
    api_response = api_instance.create_registered_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createRegisteredModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

CreateRegisteredModelRequest request to create a registered model. If the model already exists a new version is added to the list of model versions.

project_id:
Project ID string
experiment_id:
string

Experiment ID the run belongs to.

run_id:
string

ID of the ExperimentRun.

model_path:
string

Model path of model that is getting registered to model registry.

model_name:
Model name string
tags:
[

Tags for model.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
description:
string

Registered model description.

notes:
string

Registered model version notes.

visibility:
string
Default: PRIVATE
Enum: PRIVATE, PUBLIC
}

Responses

Status: 200 - A successful response.

{
model_id:
string

Model ID.

name:
string

Model name.

description:
string

Model description.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
permission:
string

Permission of the user requesting the model.

visibility:
string
Default: PRIVATE
Enum: PRIVATE, PUBLIC
created_at:
string (date-time)

Model creation time.

updated_at:
string (date-time)

Model last updated time.

count:
integer (int32)

Model version count.

model_versions:
[

Registered model versions list.

{

RegisteredModelVersion is a model version.

model_id:
string

Model ID.

model_version_id:
string

Model version ID.

version_name:
string

Model version name.

number:
integer (int32)

Model version number.

notes:
string

Model version description.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
created_at:
string (date-time)

Model version creation time.

updated_at:
string (date-time)

Model version last updated time.

status:
string

Model version status.

model_version_metadata:
{

ModelVersionMetadata is a model version metadata.

mlops_type:
string
Default: MLFLOW
Enum: MLFLOW, SIMPLE
tags:
[

tags for model.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
workspace_url:
string

Workspace URL to track back the model origins.

project_id:
string

Project ID.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
mlflow_metadata:
{

MLflowMetadata is an mlflow model metadata.

experiment_id:
string

Experiment ID the run belongs to.

run_id:
string

Run ID.

metrics:
[

Metrics for the run.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
simple_metadata:
{

SimpleMetadata is a simple model metadata.

git_url:
string

git url for model code.

commit_id:
string

commit sha for model code.

metrics:
[

metrics for the model.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
}
tags:
[

Model version tags.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
]
next_page_token:
string

next_page_token is a token to get the next page of results.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createRuntimeRepo

Create a Runtime repo.


/api/v2/runtimerepos

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimerepos"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRuntimeRepoRequest body = ; // CreateRuntimeRepoRequest | 
        try {
            RuntimeRepo result = apiInstance.createRuntimeRepo(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRuntimeRepo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRuntimeRepoRequest body = ; // CreateRuntimeRepoRequest | 
        try {
            RuntimeRepo result = apiInstance.createRuntimeRepo(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRuntimeRepo");
            e.printStackTrace();
        }
    }
}
CreateRuntimeRepoRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a  Runtime repo.
[apiInstance createRuntimeRepoWith:body
              completionHandler: ^(RuntimeRepo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateRuntimeRepoRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRuntimeRepo(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRuntimeRepoExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateRuntimeRepoRequest(); // CreateRuntimeRepoRequest | 

            try
            {
                // Create a  Runtime repo.
                RuntimeRepo result = apiInstance.createRuntimeRepo(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createRuntimeRepo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateRuntimeRepoRequest | 

try {
    $result = $api_instance->createRuntimeRepo($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createRuntimeRepo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateRuntimeRepoRequest->new(); # CreateRuntimeRepoRequest | 

eval { 
    my $result = $api_instance->createRuntimeRepo(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createRuntimeRepo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateRuntimeRepoRequest | 

try: 
    # Create a  Runtime repo.
    api_response = api_instance.create_runtime_repo(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createRuntimeRepo: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
name:
The name of this runtime repo string
url:
The URL of this runtime repo string
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createSyncedTeam

Create a synced team


/api/v2/site/synced-teams

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/site/synced-teams"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateSyncedTeamRequest body = ; // CreateSyncedTeamRequest | 
        try {
            Team result = apiInstance.createSyncedTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createSyncedTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateSyncedTeamRequest body = ; // CreateSyncedTeamRequest | 
        try {
            Team result = apiInstance.createSyncedTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createSyncedTeam");
            e.printStackTrace();
        }
    }
}
CreateSyncedTeamRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a synced team
[apiInstance createSyncedTeamWith:body
              completionHandler: ^(Team output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateSyncedTeamRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSyncedTeam(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSyncedTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateSyncedTeamRequest(); // CreateSyncedTeamRequest | 

            try
            {
                // Create a synced team
                Team result = apiInstance.createSyncedTeam(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createSyncedTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateSyncedTeamRequest | 

try {
    $result = $api_instance->createSyncedTeam($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createSyncedTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateSyncedTeamRequest->new(); # CreateSyncedTeamRequest | 

eval { 
    my $result = $api_instance->createSyncedTeam(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createSyncedTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateSyncedTeamRequest | 

try: 
    # Create a synced team
    api_response = api_instance.create_synced_team(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createSyncedTeam: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters for creating a synced team.

username:
Team name string
group_permissions:
List of groups with their default permission[
{
cn:
group name string
permission:
permission string
}
]
bio:
string

Bio of the team.

}

Responses

Status: 200 - A successful response.

Team details {
id:
id of the team string (int64)
username:
username of the team string
username_hash:
username_hash of the team string
type:
type of the team like local/ldap/saml etc string
email:
email of the team string
name:
name of the team string
bio:
bio of the team string
public_email:
public_email of the team string
admin:
admin flag of the team boolean (boolean)
business_user:
business_user flag of the team boolean (boolean)
github:
github of the team string
github_pubkey_id:
github_pubkey_id of the team string (int64)
github_oauth_completed:
github_oauth_completed of the team boolean (boolean)
last_login_at:
last_login_at time of the team string (date-time)
joined_on:
joined_on time of the team string (date-time)
followed:
followed of the team boolean (boolean)
last_seen_at:
last_seen_at time of the team string (date-time)
hadoop_username:
hadoop_username of the team string
last_logout_at_tz:
last_logout_at_tz time of the team string (date-time)
password_updated_at:
password_updated_at time of the team string (date-time)
followers:
followers of the team string (int64)
public_projects:
public_projects of the team string (int64)
organization_projects:
organization_projects of the team string (int64)
private_projects:
private_projects of the team string (int64)
running_dashboards:
running_dashboards of the team string (int64)
active_vcpus:
active_vcpus of the team string (int64)
members:
number of members in the team string (int64)
api_keys:
api_keys of the team string (int64)
last_context_id:
last_context_id of the team string (int64)
banned:
banned flag of the team boolean (boolean)
deactivated:
deactivated flag of the team boolean (boolean)
namespace:
namespace of the team string
html_url:
html_url of the team string
url:
url of the team string
sessions_run:
sessions_run of the team string (int64)
jobs_run:
jobs_run of the team string (int64)
cpu_hours:
cpu_hours of the team number (double)
gpu_hours:
gpu_hours of the team number (double)
memory_hours:
memory_hours of the team number (double)
avg_session_duration:
avg_session_duration of the team number (double)
permissions:
Permissions of given team {
business_user:
boolean (boolean)

business_user can access application.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

owner:
owner boolean (boolean)
}
account_status:
account_status of the team string
ldap_synced:
ldap_synced flag of the team boolean (boolean)
last_synced_at:
last_synced_at of the team string (date-time)
team_members:
teamMembers of the team[
Details of a team member {
id:
id of the team member integer (int32)
username:
username of the the team member string
name:
name of the team memeber string
html_url:
html_url of the team memeber string
url:
url of the team memeber string
permission:
permission of the team memeber string
}
]
inactivity_timeout:
_inactivity_timeout of the team integer (int32)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createTeam

Create a team.


/api/v2/site/teams

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/site/teams"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateTeamRequest body = ; // CreateTeamRequest | 
        try {
            Team result = apiInstance.createTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateTeamRequest body = ; // CreateTeamRequest | 
        try {
            Team result = apiInstance.createTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createTeam");
            e.printStackTrace();
        }
    }
}
CreateTeamRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a team.
[apiInstance createTeamWith:body
              completionHandler: ^(Team output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateTeamRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTeam(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateTeamRequest(); // CreateTeamRequest | 

            try
            {
                // Create a team.
                Team result = apiInstance.createTeam(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateTeamRequest | 

try {
    $result = $api_instance->createTeam($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateTeamRequest->new(); # CreateTeamRequest | 

eval { 
    my $result = $api_instance->createTeam(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateTeamRequest | 

try: 
    # Create a team.
    api_response = api_instance.create_team(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createTeam: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters for creating a team.

username:
string

ID of the project containing the model.

type:
type of the team like local/ldap/saml etc string
cn:
string

cn of the team.

bio:
string

bio of the team.

permission:
default permission of the members string
}

Responses

Status: 200 - A successful response.

Team details {
id:
id of the team string (int64)
username:
username of the team string
username_hash:
username_hash of the team string
type:
type of the team like local/ldap/saml etc string
email:
email of the team string
name:
name of the team string
bio:
bio of the team string
public_email:
public_email of the team string
admin:
admin flag of the team boolean (boolean)
business_user:
business_user flag of the team boolean (boolean)
github:
github of the team string
github_pubkey_id:
github_pubkey_id of the team string (int64)
github_oauth_completed:
github_oauth_completed of the team boolean (boolean)
last_login_at:
last_login_at time of the team string (date-time)
joined_on:
joined_on time of the team string (date-time)
followed:
followed of the team boolean (boolean)
last_seen_at:
last_seen_at time of the team string (date-time)
hadoop_username:
hadoop_username of the team string
last_logout_at_tz:
last_logout_at_tz time of the team string (date-time)
password_updated_at:
password_updated_at time of the team string (date-time)
followers:
followers of the team string (int64)
public_projects:
public_projects of the team string (int64)
organization_projects:
organization_projects of the team string (int64)
private_projects:
private_projects of the team string (int64)
running_dashboards:
running_dashboards of the team string (int64)
active_vcpus:
active_vcpus of the team string (int64)
members:
number of members in the team string (int64)
api_keys:
api_keys of the team string (int64)
last_context_id:
last_context_id of the team string (int64)
banned:
banned flag of the team boolean (boolean)
deactivated:
deactivated flag of the team boolean (boolean)
namespace:
namespace of the team string
html_url:
html_url of the team string
url:
url of the team string
sessions_run:
sessions_run of the team string (int64)
jobs_run:
jobs_run of the team string (int64)
cpu_hours:
cpu_hours of the team number (double)
gpu_hours:
gpu_hours of the team number (double)
memory_hours:
memory_hours of the team number (double)
avg_session_duration:
avg_session_duration of the team number (double)
permissions:
Permissions of given team {
business_user:
boolean (boolean)

business_user can access application.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

owner:
owner boolean (boolean)
}
account_status:
account_status of the team string
ldap_synced:
ldap_synced flag of the team boolean (boolean)
last_synced_at:
last_synced_at of the team string (date-time)
team_members:
teamMembers of the team[
Details of a team member {
id:
id of the team member integer (int32)
username:
username of the the team member string
name:
name of the team memeber string
html_url:
html_url of the team memeber string
url:
url of the team memeber string
permission:
permission of the team memeber string
}
]
inactivity_timeout:
_inactivity_timeout of the team integer (int32)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

createV2Key

Create API V2 key


/api/v2/users/{username}/v2_keys

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/users/{username}/v2_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateV2KeyRequest body = ; // CreateV2KeyRequest | 
        String username = username_example; // String | username of the user whose V2 key you want to create
        try {
            CreateV2KeyResponse result = apiInstance.createV2Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createV2Key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateV2KeyRequest body = ; // CreateV2KeyRequest | 
        String username = username_example; // String | username of the user whose V2 key you want to create
        try {
            CreateV2KeyResponse result = apiInstance.createV2Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createV2Key");
            e.printStackTrace();
        }
    }
}
CreateV2KeyRequest *body = ; // 
String *username = username_example; // username of the user whose V2 key you want to create

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create API V2 key
[apiInstance createV2KeyWith:body
    username:username
              completionHandler: ^(CreateV2KeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateV2KeyRequest}} 
var username = username_example; // {{String}} username of the user whose V2 key you want to create

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createV2Key(bodyusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createV2KeyExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateV2KeyRequest(); // CreateV2KeyRequest | 
            var username = username_example;  // String | username of the user whose V2 key you want to create

            try
            {
                // Create API V2 key
                CreateV2KeyResponse result = apiInstance.createV2Key(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createV2Key: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateV2KeyRequest | 
$username = username_example; // String | username of the user whose V2 key you want to create

try {
    $result = $api_instance->createV2Key($body, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createV2Key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateV2KeyRequest->new(); # CreateV2KeyRequest | 
my $username = username_example; # String | username of the user whose V2 key you want to create

eval { 
    my $result = $api_instance->createV2Key(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createV2Key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateV2KeyRequest | 
username = username_example # String | username of the user whose V2 key you want to create

try: 
    # Create API V2 key
    api_response = api_instance.create_v2_key(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createV2Key: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 key you want to create
Required
Body parameters
Name Description
body *
{
username:
username of the user whose V2 key you want to create string
expiry_date:
expiry_date - optional string
comments:
comments - optional string
}

Responses

Status: 200 - A successful response.

{
api_key:
New api_key string
key_id:
New key_id string
created_at:
New created_at string
expiry_date:
New expiry_date string
comments:
New comments string
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteApplication

Delete an application.


/api/v2/projects/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an application.
[apiInstance deleteApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(DeleteApplicationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Delete an application.
                DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->deleteApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->deleteApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Delete an application.
    api_response = api_instance.delete_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteCopilotEmbeddingModel

Delete a Copilot embedding model.


/api/v2/copilot/embedding_models/{copilot_embedding_model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/copilot/embedding_models/{copilot_embedding_model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotEmbeddingModelId = copilotEmbeddingModelId_example; // String | 
        try {
            DeleteCopilotEmbeddingModelResponse result = apiInstance.deleteCopilotEmbeddingModel(copilotEmbeddingModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotEmbeddingModelId = copilotEmbeddingModelId_example; // String | 
        try {
            DeleteCopilotEmbeddingModelResponse result = apiInstance.deleteCopilotEmbeddingModel(copilotEmbeddingModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
String *copilotEmbeddingModelId = copilotEmbeddingModelId_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a Copilot embedding model.
[apiInstance deleteCopilotEmbeddingModelWith:copilotEmbeddingModelId
              completionHandler: ^(DeleteCopilotEmbeddingModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var copilotEmbeddingModelId = copilotEmbeddingModelId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCopilotEmbeddingModel(copilotEmbeddingModelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCopilotEmbeddingModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var copilotEmbeddingModelId = copilotEmbeddingModelId_example;  // String | 

            try
            {
                // Delete a Copilot embedding model.
                DeleteCopilotEmbeddingModelResponse result = apiInstance.deleteCopilotEmbeddingModel(copilotEmbeddingModelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteCopilotEmbeddingModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$copilotEmbeddingModelId = copilotEmbeddingModelId_example; // String | 

try {
    $result = $api_instance->deleteCopilotEmbeddingModel($copilotEmbeddingModelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteCopilotEmbeddingModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $copilotEmbeddingModelId = copilotEmbeddingModelId_example; # String | 

eval { 
    my $result = $api_instance->deleteCopilotEmbeddingModel(copilotEmbeddingModelId => $copilotEmbeddingModelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteCopilotEmbeddingModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
copilotEmbeddingModelId = copilotEmbeddingModelId_example # String | 

try: 
    # Delete a Copilot embedding model.
    api_response = api_instance.delete_copilot_embedding_model(copilotEmbeddingModelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteCopilotEmbeddingModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_embedding_model_id*
String
Required

Responses

Status: 200 - A successful response.

{

Response for deleting an embedding model.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteCopilotModel

Delete a Copilot model.


/api/v2/copilot/models/{copilot_model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/copilot/models/{copilot_model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotModelId = copilotModelId_example; // String | 
        try {
            DeleteCopilotModelResponse result = apiInstance.deleteCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotModelId = copilotModelId_example; // String | 
        try {
            DeleteCopilotModelResponse result = apiInstance.deleteCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteCopilotModel");
            e.printStackTrace();
        }
    }
}
String *copilotModelId = copilotModelId_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a Copilot model.
[apiInstance deleteCopilotModelWith:copilotModelId
              completionHandler: ^(DeleteCopilotModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var copilotModelId = copilotModelId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCopilotModel(copilotModelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCopilotModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var copilotModelId = copilotModelId_example;  // String | 

            try
            {
                // Delete a Copilot model.
                DeleteCopilotModelResponse result = apiInstance.deleteCopilotModel(copilotModelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteCopilotModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$copilotModelId = copilotModelId_example; // String | 

try {
    $result = $api_instance->deleteCopilotModel($copilotModelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteCopilotModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $copilotModelId = copilotModelId_example; # String | 

eval { 
    my $result = $api_instance->deleteCopilotModel(copilotModelId => $copilotModelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteCopilotModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
copilotModelId = copilotModelId_example # String | 

try: 
    # Delete a Copilot model.
    api_response = api_instance.delete_copilot_model(copilotModelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteCopilotModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_model_id*
String
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a model.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteDockerCredential

Delete a Docker credential.


/api/v2/dockercredentials/{docker_credential_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/dockercredentials/{docker_credential_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String dockerCredentialId = dockerCredentialId_example; // String | the id of the docker credential to delete
        try {
            DeleteDockerCredentialResponse result = apiInstance.deleteDockerCredential(dockerCredentialId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteDockerCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String dockerCredentialId = dockerCredentialId_example; // String | the id of the docker credential to delete
        try {
            DeleteDockerCredentialResponse result = apiInstance.deleteDockerCredential(dockerCredentialId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteDockerCredential");
            e.printStackTrace();
        }
    }
}
String *dockerCredentialId = dockerCredentialId_example; // the id of the docker credential to delete

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a Docker credential.
[apiInstance deleteDockerCredentialWith:dockerCredentialId
              completionHandler: ^(DeleteDockerCredentialResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var dockerCredentialId = dockerCredentialId_example; // {{String}} the id of the docker credential to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDockerCredential(dockerCredentialId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDockerCredentialExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var dockerCredentialId = dockerCredentialId_example;  // String | the id of the docker credential to delete

            try
            {
                // Delete a Docker credential.
                DeleteDockerCredentialResponse result = apiInstance.deleteDockerCredential(dockerCredentialId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteDockerCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$dockerCredentialId = dockerCredentialId_example; // String | the id of the docker credential to delete

try {
    $result = $api_instance->deleteDockerCredential($dockerCredentialId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteDockerCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $dockerCredentialId = dockerCredentialId_example; # String | the id of the docker credential to delete

eval { 
    my $result = $api_instance->deleteDockerCredential(dockerCredentialId => $dockerCredentialId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteDockerCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
dockerCredentialId = dockerCredentialId_example # String | the id of the docker credential to delete

try: 
    # Delete a Docker credential.
    api_response = api_instance.delete_docker_credential(dockerCredentialId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteDockerCredential: %s\n" % e)

Parameters

Path parameters
Name Description
docker_credential_id*
String
the id of the docker credential to delete
Required

Responses

Status: 200 - A successful response.

{
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteExperiment

Delete an experiment that belongs to an experiment id.


/api/v2/projects/{project_id}/experiments/{experiment_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        try {
            DeleteExperimentResponse result = apiInstance.deleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        try {
            DeleteExperimentResponse result = apiInstance.deleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an experiment that belongs to an experiment id.
[apiInstance deleteExperimentWith:projectId
    experimentId:experimentId
              completionHandler: ^(DeleteExperimentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExperiment(projectId, experimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 

            try
            {
                // Delete an experiment that belongs to an experiment id.
                DeleteExperimentResponse result = apiInstance.deleteExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 

try {
    $result = $api_instance->deleteExperiment($projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 

eval { 
    my $result = $api_instance->deleteExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 

try: 
    # Delete an experiment that belongs to an experiment id.
    api_response = api_instance.delete_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required

Responses

Status: 200 - A successful response.

{

The response from deleting an experiment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteExperimentRun

Delete an experiment run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project the experiment run lives in.
        String experimentId = experimentId_example; // String | The experiment the run is a part of.
        String runId = runId_example; // String | The ID of the run to delete.
        try {
            DeleteExperimentRunResponse result = apiInstance.deleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project the experiment run lives in.
        String experimentId = experimentId_example; // String | The experiment the run is a part of.
        String runId = runId_example; // String | The ID of the run to delete.
        try {
            DeleteExperimentRunResponse result = apiInstance.deleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project the experiment run lives in.
String *experimentId = experimentId_example; // The experiment the run is a part of.
String *runId = runId_example; // The ID of the run to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an experiment run.
[apiInstance deleteExperimentRunWith:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(DeleteExperimentRunResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project the experiment run lives in.
var experimentId = experimentId_example; // {{String}} The experiment the run is a part of.
var runId = runId_example; // {{String}} The ID of the run to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExperimentRun(projectId, experimentId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project the experiment run lives in.
            var experimentId = experimentId_example;  // String | The experiment the run is a part of.
            var runId = runId_example;  // String | The ID of the run to delete.

            try
            {
                // Delete an experiment run.
                DeleteExperimentRunResponse result = apiInstance.deleteExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project the experiment run lives in.
$experimentId = experimentId_example; // String | The experiment the run is a part of.
$runId = runId_example; // String | The ID of the run to delete.

try {
    $result = $api_instance->deleteExperimentRun($projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project the experiment run lives in.
my $experimentId = experimentId_example; # String | The experiment the run is a part of.
my $runId = runId_example; # String | The ID of the run to delete.

eval { 
    my $result = $api_instance->deleteExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project the experiment run lives in.
experimentId = experimentId_example # String | The experiment the run is a part of.
runId = runId_example # String | The ID of the run to delete.

try: 
    # Delete an experiment run.
    api_response = api_instance.delete_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project the experiment run lives in.
Required
experiment_id*
String
The experiment the run is a part of.
Required
run_id*
String
The ID of the run to delete.
Required

Responses

Status: 200 - A successful response.

{

Response object for deleting an experiment run.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteExperimentRunBatch

Bulk delete an experiment run details like metrics, params, tags in one request.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:deletebatch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:deletebatch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        DeleteExperimentRunBatchRequest body = ; // DeleteExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            DeleteExperimentRunBatchResponse result = apiInstance.deleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        DeleteExperimentRunBatchRequest body = ; // DeleteExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            DeleteExperimentRunBatchResponse result = apiInstance.deleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
DeleteExperimentRunBatchRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 
String *runId = runId_example; // ID of the ExperimentRun to log under

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Bulk delete an experiment run details like metrics, params, tags in one request.
[apiInstance deleteExperimentRunBatchWith:body
    projectId:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(DeleteExperimentRunBatchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{DeleteExperimentRunBatchRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 
var runId = runId_example; // {{String}} ID of the ExperimentRun to log under

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExperimentRunBatch(bodyprojectIdexperimentIdrunId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExperimentRunBatchExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new DeleteExperimentRunBatchRequest(); // DeleteExperimentRunBatchRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 
            var runId = runId_example;  // String | ID of the ExperimentRun to log under

            try
            {
                // Bulk delete an experiment run details like metrics, params, tags in one request.
                DeleteExperimentRunBatchResponse result = apiInstance.deleteExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteExperimentRunBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // DeleteExperimentRunBatchRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 
$runId = runId_example; // String | ID of the ExperimentRun to log under

try {
    $result = $api_instance->deleteExperimentRunBatch($body, $projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteExperimentRunBatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::DeleteExperimentRunBatchRequest->new(); # DeleteExperimentRunBatchRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 
my $runId = runId_example; # String | ID of the ExperimentRun to log under

eval { 
    my $result = $api_instance->deleteExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteExperimentRunBatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # DeleteExperimentRunBatchRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 
runId = runId_example # String | ID of the ExperimentRun to log under

try: 
    # Bulk delete an experiment run details like metrics, params, tags in one request.
    api_response = api_instance.delete_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteExperimentRunBatch: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required
run_id*
String
ID of the ExperimentRun to log under
Required
Body parameters
Name Description
body *
{

DeleteExperimentRunBatchRequest is used to builk delete metrics, params, tags in one request.

project_id:
string
experiment_id:
string
run_id:
ID of the ExperimentRun to log under string
metrics:
[

List of metric names to be deleted.

string
]
params:
[

List of param names to be deleted.

string
]
tags:
[

List of tags to be deleted.

string
]
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteJob

Deletes a job.


/api/v2/projects/{project_id}/jobs/{job_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | the public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            DeleteJobResponse result = apiInstance.deleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | the public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            DeleteJobResponse result = apiInstance.deleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteJob");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // the public project identifier
String *jobId = jobId_example; // The public job identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Deletes a job.
[apiInstance deleteJobWith:projectId
    jobId:jobId
              completionHandler: ^(DeleteJobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} the public project identifier
var jobId = jobId_example; // {{String}} The public job identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteJob(projectId, jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | the public project identifier
            var jobId = jobId_example;  // String | The public job identifier

            try
            {
                // Deletes a job.
                DeleteJobResponse result = apiInstance.deleteJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | the public project identifier
$jobId = jobId_example; // String | The public job identifier

try {
    $result = $api_instance->deleteJob($projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | the public project identifier
my $jobId = jobId_example; # String | The public job identifier

eval { 
    my $result = $api_instance->deleteJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | the public project identifier
jobId = jobId_example # String | The public job identifier

try: 
    # Deletes a job.
    api_response = api_instance.delete_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
the public project identifier
Required
job_id*
String
The public job identifier
Required

Responses

Status: 200 - A successful response.

{

Response to DELETE a job.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteModel

Delete a model.


/api/v2/projects/{project_id}/models/{model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to delete.
        try {
            DeleteModelResponse result = apiInstance.deleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to delete.
        try {
            DeleteModelResponse result = apiInstance.deleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModel");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a model.
[apiInstance deleteModelWith:projectId
    modelId:modelId
              completionHandler: ^(DeleteModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteModel(projectId, modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to delete.

            try
            {
                // Delete a model.
                DeleteModelResponse result = apiInstance.deleteModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to delete.

try {
    $result = $api_instance->deleteModel($projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to delete.

eval { 
    my $result = $api_instance->deleteModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to delete.

try: 
    # Delete a model.
    api_response = api_instance.delete_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to delete.
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a model.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteModelBuild

Delete a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the build to delete.
        try {
            DeleteModelBuildResponse result = apiInstance.deleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the build to delete.
        try {
            DeleteModelBuildResponse result = apiInstance.deleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModelBuild");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the build.
String *buildId = buildId_example; // ID of the build to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a model build.
[apiInstance deleteModelBuildWith:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(DeleteModelBuildResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the build.
var buildId = buildId_example; // {{String}} ID of the build to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteModelBuild(projectId, modelId, buildId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteModelBuildExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the build.
            var buildId = buildId_example;  // String | ID of the build to delete.

            try
            {
                // Delete a model build.
                DeleteModelBuildResponse result = apiInstance.deleteModelBuild(projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the build.
$buildId = buildId_example; // String | ID of the build to delete.

try {
    $result = $api_instance->deleteModelBuild($projectId, $modelId, $buildId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteModelBuild: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the build.
my $buildId = buildId_example; # String | ID of the build to delete.

eval { 
    my $result = $api_instance->deleteModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteModelBuild: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the build.
buildId = buildId_example # String | ID of the build to delete.

try: 
    # Delete a model build.
    api_response = api_instance.delete_model_build(projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the build.
Required
build_id*
String
ID of the build to delete.
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a model build.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteProject

Delete a project.


/api/v2/projects/{project_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        try {
            DeleteProjectResponse result = apiInstance.deleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        try {
            DeleteProjectResponse result = apiInstance.deleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a project.
[apiInstance deleteProjectWith:projectId
              completionHandler: ^(DeleteProjectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier

            try
            {
                // Delete a project.
                DeleteProjectResponse result = apiInstance.deleteProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier

try {
    $result = $api_instance->deleteProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier

eval { 
    my $result = $api_instance->deleteProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project's identifier

try: 
    # Delete a project.
    api_response = api_instance.delete_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required

Responses

Status: 200 - A successful response.

{

Response object when deleting a project.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteProjectCollaborator

Delete a project collaborator


/api/v2/projects/{project_id}/collaborators/{username}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/collaborators/{username}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            DeleteProjectCollaboratorResponse result = apiInstance.deleteProjectCollaborator(projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectCollaborator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            DeleteProjectCollaboratorResponse result = apiInstance.deleteProjectCollaborator(projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectCollaborator");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project.
String *username = username_example; // The username of the collaborator to add.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a project collaborator
[apiInstance deleteProjectCollaboratorWith:projectId
    username:username
              completionHandler: ^(DeleteProjectCollaboratorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project.
var username = username_example; // {{String}} The username of the collaborator to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProjectCollaborator(projectId, username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectCollaboratorExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project.
            var username = username_example;  // String | The username of the collaborator to add.

            try
            {
                // Delete a project collaborator
                DeleteProjectCollaboratorResponse result = apiInstance.deleteProjectCollaborator(projectId, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteProjectCollaborator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project.
$username = username_example; // String | The username of the collaborator to add.

try {
    $result = $api_instance->deleteProjectCollaborator($projectId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteProjectCollaborator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project.
my $username = username_example; # String | The username of the collaborator to add.

eval { 
    my $result = $api_instance->deleteProjectCollaborator(projectId => $projectId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteProjectCollaborator: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project.
username = username_example # String | The username of the collaborator to add.

try: 
    # Delete a project collaborator
    api_response = api_instance.delete_project_collaborator(projectId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteProjectCollaborator: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project.
Required
username*
String
The username of the collaborator to add.
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a project collaborator.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteProjectFile

Delete a file or directory.


/api/v2/projects/{project_id}/files/{path}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/files/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file or directory to delete.
        try {
            DeleteProjectFileResponse result = apiInstance.deleteProjectFile(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file or directory to delete.
        try {
            DeleteProjectFileResponse result = apiInstance.deleteProjectFile(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectFile");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project that contains the file or directory.
String *path = path_example; // The path to the file or directory to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a file or directory.
[apiInstance deleteProjectFileWith:projectId
    path:path
              completionHandler: ^(DeleteProjectFileResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project that contains the file or directory.
var path = path_example; // {{String}} The path to the file or directory to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProjectFile(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectFileExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project that contains the file or directory.
            var path = path_example;  // String | The path to the file or directory to delete.

            try
            {
                // Delete a file or directory.
                DeleteProjectFileResponse result = apiInstance.deleteProjectFile(projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteProjectFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
$path = path_example; // String | The path to the file or directory to delete.

try {
    $result = $api_instance->deleteProjectFile($projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteProjectFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project that contains the file or directory.
my $path = path_example; # String | The path to the file or directory to delete.

eval { 
    my $result = $api_instance->deleteProjectFile(projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteProjectFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project that contains the file or directory.
path = path_example # String | The path to the file or directory to delete.

try: 
    # Delete a file or directory.
    api_response = api_instance.delete_project_file(projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteProjectFile: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project that contains the file or directory.
Required
path*
String
The path to the file or directory to delete.
Required

Responses

Status: 200 - A successful response.

{

Response object for deleting a file or directory.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteRegisteredModel

Unregister a model deletes a model.


/api/v2/registry/models/{model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        try {
            DeleteRegisteredModelResponse result = apiInstance.deleteRegisteredModel(modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        try {
            DeleteRegisteredModelResponse result = apiInstance.deleteRegisteredModel(modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModel");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Unregister a model deletes a model.
[apiInstance deleteRegisteredModelWith:modelId
              completionHandler: ^(DeleteRegisteredModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRegisteredModel(modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.

            try
            {
                // Unregister a model deletes a model.
                DeleteRegisteredModelResponse result = apiInstance.deleteRegisteredModel(modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.

try {
    $result = $api_instance->deleteRegisteredModel($modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.

eval { 
    my $result = $api_instance->deleteRegisteredModel(modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.

try: 
    # Unregister a model deletes a model.
    api_response = api_instance.delete_registered_model(modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteRegisteredModel: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required

Responses

Status: 200 - A successful response.

{

DeleteRegisteredModelResponse.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteRegisteredModelVersion

Unregister a model version.


/api/v2/registry/models/{model_id}/versions/{version_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}/versions/{version_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            DeleteRegisteredModelVersionResponse result = apiInstance.deleteRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            DeleteRegisteredModelVersionResponse result = apiInstance.deleteRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.
String *versionId = versionId_example; // Model version ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Unregister a model version.
[apiInstance deleteRegisteredModelVersionWith:modelId
    versionId:versionId
              completionHandler: ^(DeleteRegisteredModelVersionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.
var versionId = versionId_example; // {{String}} Model version ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRegisteredModelVersion(modelId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRegisteredModelVersionExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.
            var versionId = versionId_example;  // String | Model version ID.

            try
            {
                // Unregister a model version.
                DeleteRegisteredModelVersionResponse result = apiInstance.deleteRegisteredModelVersion(modelId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteRegisteredModelVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.
$versionId = versionId_example; // String | Model version ID.

try {
    $result = $api_instance->deleteRegisteredModelVersion($modelId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteRegisteredModelVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.
my $versionId = versionId_example; # String | Model version ID.

eval { 
    my $result = $api_instance->deleteRegisteredModelVersion(modelId => $modelId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteRegisteredModelVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.
versionId = versionId_example # String | Model version ID.

try: 
    # Unregister a model version.
    api_response = api_instance.delete_registered_model_version(modelId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteRegisteredModelVersion: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
version_id*
String
Model version ID.
Required

Responses

Status: 200 - A successful response.

{

DeleteRegisteredModelVersionResponse.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteRuntimeRepo

Delete a Runtime repo.


/api/v2/runtimerepos/{runtime_repo_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/runtimerepos/{runtime_repo_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer runtimeRepoId = 56; // Integer | the id of the Runtime Repo to delete
        try {
            DeleteRuntimeRepoResponse result = apiInstance.deleteRuntimeRepo(runtimeRepoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRuntimeRepo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer runtimeRepoId = 56; // Integer | the id of the Runtime Repo to delete
        try {
            DeleteRuntimeRepoResponse result = apiInstance.deleteRuntimeRepo(runtimeRepoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRuntimeRepo");
            e.printStackTrace();
        }
    }
}
Integer *runtimeRepoId = 56; // the id of the Runtime Repo to delete

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a Runtime repo.
[apiInstance deleteRuntimeRepoWith:runtimeRepoId
              completionHandler: ^(DeleteRuntimeRepoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var runtimeRepoId = 56; // {{Integer}} the id of the Runtime Repo to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRuntimeRepo(runtimeRepoId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRuntimeRepoExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var runtimeRepoId = 56;  // Integer | the id of the Runtime Repo to delete

            try
            {
                // Delete a Runtime repo.
                DeleteRuntimeRepoResponse result = apiInstance.deleteRuntimeRepo(runtimeRepoId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteRuntimeRepo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$runtimeRepoId = 56; // Integer | the id of the Runtime Repo to delete

try {
    $result = $api_instance->deleteRuntimeRepo($runtimeRepoId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteRuntimeRepo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $runtimeRepoId = 56; # Integer | the id of the Runtime Repo to delete

eval { 
    my $result = $api_instance->deleteRuntimeRepo(runtimeRepoId => $runtimeRepoId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteRuntimeRepo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
runtimeRepoId = 56 # Integer | the id of the Runtime Repo to delete

try: 
    # Delete a Runtime repo.
    api_response = api_instance.delete_runtime_repo(runtimeRepoId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteRuntimeRepo: %s\n" % e)

Parameters

Path parameters
Name Description
runtime_repo_id*
Integer (int32)
the id of the Runtime Repo to delete
Required

Responses

Status: 200 - A successful response.

{
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteTeam

Delete a team.


/api/v2/teams/{team_name}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/teams/{team_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | name of the team you want to delete
        try {
            DeleteTeamResponse result = apiInstance.deleteTeam(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | name of the team you want to delete
        try {
            DeleteTeamResponse result = apiInstance.deleteTeam(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteTeam");
            e.printStackTrace();
        }
    }
}
String *teamName = teamName_example; // name of the team you want to delete

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a team.
[apiInstance deleteTeamWith:teamName
              completionHandler: ^(DeleteTeamResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var teamName = teamName_example; // {{String}} name of the team you want to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteTeam(teamName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var teamName = teamName_example;  // String | name of the team you want to delete

            try
            {
                // Delete a team.
                DeleteTeamResponse result = apiInstance.deleteTeam(teamName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$teamName = teamName_example; // String | name of the team you want to delete

try {
    $result = $api_instance->deleteTeam($teamName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $teamName = teamName_example; # String | name of the team you want to delete

eval { 
    my $result = $api_instance->deleteTeam(teamName => $teamName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
teamName = teamName_example # String | name of the team you want to delete

try: 
    # Delete a team.
    api_response = api_instance.delete_team(teamName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteTeam: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
name of the team you want to delete
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a team.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteV2Key

Delete an API V2 key


/api/v2/users/{username}/v2_keys/{key_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/users/{username}/v2_keys/{key_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 key you want to delete
        String keyId = keyId_example; // String | ID of the V2 key
        try {
            DeleteV2KeyResponse result = apiInstance.deleteV2Key(username, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 key you want to delete
        String keyId = keyId_example; // String | ID of the V2 key
        try {
            DeleteV2KeyResponse result = apiInstance.deleteV2Key(username, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Key");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // username of the user whose V2 key you want to delete
String *keyId = keyId_example; // ID of the V2 key

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an API V2 key
[apiInstance deleteV2KeyWith:username
    keyId:keyId
              completionHandler: ^(DeleteV2KeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var username = username_example; // {{String}} username of the user whose V2 key you want to delete
var keyId = keyId_example; // {{String}} ID of the V2 key

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteV2Key(username, keyId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteV2KeyExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var username = username_example;  // String | username of the user whose V2 key you want to delete
            var keyId = keyId_example;  // String | ID of the V2 key

            try
            {
                // Delete an API V2 key
                DeleteV2KeyResponse result = apiInstance.deleteV2Key(username, keyId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteV2Key: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$username = username_example; // String | username of the user whose V2 key you want to delete
$keyId = keyId_example; // String | ID of the V2 key

try {
    $result = $api_instance->deleteV2Key($username, $keyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteV2Key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $username = username_example; # String | username of the user whose V2 key you want to delete
my $keyId = keyId_example; # String | ID of the V2 key

eval { 
    my $result = $api_instance->deleteV2Key(username => $username, keyId => $keyId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteV2Key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
username = username_example # String | username of the user whose V2 key you want to delete
keyId = keyId_example # String | ID of the V2 key

try: 
    # Delete an API V2 key
    api_response = api_instance.delete_v2_key(username, keyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteV2Key: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 key you want to delete
Required
key_id*
String
ID of the V2 key
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a V2 key.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

deleteV2Keys

Delete all API V2 keys


/api/v2/users/{username}/v2_keys

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/users/{username}/v2_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to delete
        try {
            DeleteV2KeysResponse result = apiInstance.deleteV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Keys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to delete
        try {
            DeleteV2KeysResponse result = apiInstance.deleteV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Keys");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // username of the user whose V2 keys you want to delete

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete all API V2 keys
[apiInstance deleteV2KeysWith:username
              completionHandler: ^(DeleteV2KeysResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var username = username_example; // {{String}} username of the user whose V2 keys you want to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteV2Keys(username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteV2KeysExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var username = username_example;  // String | username of the user whose V2 keys you want to delete

            try
            {
                // Delete all API V2 keys
                DeleteV2KeysResponse result = apiInstance.deleteV2Keys(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteV2Keys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$username = username_example; // String | username of the user whose V2 keys you want to delete

try {
    $result = $api_instance->deleteV2Keys($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteV2Keys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $username = username_example; # String | username of the user whose V2 keys you want to delete

eval { 
    my $result = $api_instance->deleteV2Keys(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteV2Keys: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
username = username_example # String | username of the user whose V2 keys you want to delete

try: 
    # Delete all API V2 keys
    api_response = api_instance.delete_v2_keys(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteV2Keys: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 keys you want to delete
Required

Responses

Status: 200 - A successful response.

{

Response for deleting all V2 keys.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

disableEngines

Disable engines


/api/v2/site/config:update

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/site/config:update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        DisableEnginesRequest body = ; // DisableEnginesRequest | 
        try {
            DisableEnginesResponse result = apiInstance.disableEngines(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#disableEngines");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        DisableEnginesRequest body = ; // DisableEnginesRequest | 
        try {
            DisableEnginesResponse result = apiInstance.disableEngines(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#disableEngines");
            e.printStackTrace();
        }
    }
}
DisableEnginesRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Disable engines
[apiInstance disableEnginesWith:body
              completionHandler: ^(DisableEnginesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{DisableEnginesRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableEngines(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disableEnginesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new DisableEnginesRequest(); // DisableEnginesRequest | 

            try
            {
                // Disable engines
                DisableEnginesResponse result = apiInstance.disableEngines(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.disableEngines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // DisableEnginesRequest | 

try {
    $result = $api_instance->disableEngines($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->disableEngines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::DisableEnginesRequest->new(); # DisableEnginesRequest | 

eval { 
    my $result = $api_instance->disableEngines(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->disableEngines: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # DisableEnginesRequest | 

try: 
    # Disable engines
    api_response = api_instance.disable_engines(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->disableEngines: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to update engines disablement.

disable_engines:
Status whether disabled or not boolean (boolean)
}

Responses

Status: 200 - A successful response.

{

Response for updating engines disablement.

rows_affected:
Projects that updated integer (int32)
check:
Check status of the engines boolean (boolean)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

downloadProjectFile

download a project file


/api/v2/projects/{project_id}/files/{path}:download

Usage and SDK Samples

curl -X POST\
"//api/v2/projects/{project_id}/files/{path}:download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String path = path_example; // String | The path of the file to download
        try {
            apiInstance.downloadProjectFile(projectId, path);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#downloadProjectFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String path = path_example; // String | The path of the file to download
        try {
            apiInstance.downloadProjectFile(projectId, path);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#downloadProjectFile");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
String *path = path_example; // The path of the file to download

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// download a project file
[apiInstance downloadProjectFileWith:projectId
    path:path
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var path = path_example; // {{String}} The path of the file to download

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadProjectFile(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadProjectFileExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var path = path_example;  // String | The path of the file to download

            try
            {
                // download a project file
                apiInstance.downloadProjectFile(projectId, path);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.downloadProjectFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$path = path_example; // String | The path of the file to download

try {
    $api_instance->downloadProjectFile($projectId, $path);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->downloadProjectFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $path = path_example; # String | The path of the file to download

eval { 
    $api_instance->downloadProjectFile(projectId => $projectId, path => $path);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->downloadProjectFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
path = path_example # String | The path of the file to download

try: 
    # download a project file
    api_instance.download_project_file(projectId, path)
except ApiException as e:
    print("Exception when calling CMLServiceApi->downloadProjectFile: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
path*
String
The path of the file to download
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response.

getApplication

Get an application.


/api/v2/projects/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.getApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.getApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get an application.
[apiInstance getApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Get an application.
                Application result = apiInstance.getApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->getApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->getApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Get an application.
    api_response = api_instance.get_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getCopilotEmbeddingModel

Get a Copilot embedding model.


/api/v2/copilot/embedding_model/{copilot_embedding_model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/copilot/embedding_model/{copilot_embedding_model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotEmbeddingModelId = copilotEmbeddingModelId_example; // String | The Copilot embedding model's ID.
        try {
            CopilotEmbeddingModel result = apiInstance.getCopilotEmbeddingModel(copilotEmbeddingModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotEmbeddingModelId = copilotEmbeddingModelId_example; // String | The Copilot embedding model's ID.
        try {
            CopilotEmbeddingModel result = apiInstance.getCopilotEmbeddingModel(copilotEmbeddingModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
String *copilotEmbeddingModelId = copilotEmbeddingModelId_example; // The Copilot embedding model's ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a Copilot embedding model.
[apiInstance getCopilotEmbeddingModelWith:copilotEmbeddingModelId
              completionHandler: ^(CopilotEmbeddingModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var copilotEmbeddingModelId = copilotEmbeddingModelId_example; // {{String}} The Copilot embedding model's ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCopilotEmbeddingModel(copilotEmbeddingModelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCopilotEmbeddingModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var copilotEmbeddingModelId = copilotEmbeddingModelId_example;  // String | The Copilot embedding model's ID.

            try
            {
                // Get a Copilot embedding model.
                CopilotEmbeddingModel result = apiInstance.getCopilotEmbeddingModel(copilotEmbeddingModelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getCopilotEmbeddingModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$copilotEmbeddingModelId = copilotEmbeddingModelId_example; // String | The Copilot embedding model's ID.

try {
    $result = $api_instance->getCopilotEmbeddingModel($copilotEmbeddingModelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getCopilotEmbeddingModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $copilotEmbeddingModelId = copilotEmbeddingModelId_example; # String | The Copilot embedding model's ID.

eval { 
    my $result = $api_instance->getCopilotEmbeddingModel(copilotEmbeddingModelId => $copilotEmbeddingModelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getCopilotEmbeddingModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
copilotEmbeddingModelId = copilotEmbeddingModelId_example # String | The Copilot embedding model's ID.

try: 
    # Get a Copilot embedding model.
    api_response = api_instance.get_copilot_embedding_model(copilotEmbeddingModelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getCopilotEmbeddingModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_embedding_model_id*
String
The Copilot embedding model's ID.
Required

Responses

Status: 200 - A successful response.

Copilot Embedding Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getCopilotModel

Get a Copilot model.


/api/v2/copilot/model/{copilot_model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/copilot/model/{copilot_model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotModelId = copilotModelId_example; // String | The Copilot model's ID.
        try {
            CopilotModel result = apiInstance.getCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotModelId = copilotModelId_example; // String | The Copilot model's ID.
        try {
            CopilotModel result = apiInstance.getCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getCopilotModel");
            e.printStackTrace();
        }
    }
}
String *copilotModelId = copilotModelId_example; // The Copilot model's ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a Copilot model.
[apiInstance getCopilotModelWith:copilotModelId
              completionHandler: ^(CopilotModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var copilotModelId = copilotModelId_example; // {{String}} The Copilot model's ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCopilotModel(copilotModelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCopilotModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var copilotModelId = copilotModelId_example;  // String | The Copilot model's ID.

            try
            {
                // Get a Copilot model.
                CopilotModel result = apiInstance.getCopilotModel(copilotModelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getCopilotModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$copilotModelId = copilotModelId_example; // String | The Copilot model's ID.

try {
    $result = $api_instance->getCopilotModel($copilotModelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getCopilotModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $copilotModelId = copilotModelId_example; # String | The Copilot model's ID.

eval { 
    my $result = $api_instance->getCopilotModel(copilotModelId => $copilotModelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getCopilotModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
copilotModelId = copilotModelId_example # String | The Copilot model's ID.

try: 
    # Get a Copilot model.
    api_response = api_instance.get_copilot_model(copilotModelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getCopilotModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_model_id*
String
The Copilot model's ID.
Required

Responses

Status: 200 - A successful response.

Copilot Language Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getExperiment

Return one experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            Experiment result = apiInstance.getExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            Experiment result = apiInstance.getExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return one experiment.
[apiInstance getExperimentWith:projectId
    experimentId:experimentId
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperiment(projectId, experimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.

            try
            {
                // Return one experiment.
                Experiment result = apiInstance.getExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.

try {
    $result = $api_instance->getExperiment($projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.

eval { 
    my $result = $api_instance->getExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.

try: 
    # Return one experiment.
    api_response = api_instance.get_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required

Responses

Status: 200 - A successful response.

{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getExperimentRun

Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp. If there are multiple values with the latest timestamp, return the maximum of these values.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.
        try {
            ExperimentRun result = apiInstance.getExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.
        try {
            ExperimentRun result = apiInstance.getExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.
String *runId = runId_example; // ID of the ExperimentRun to fetch. Must be provided.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
[apiInstance getExperimentRunWith:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.
var runId = runId_example; // {{String}} ID of the ExperimentRun to fetch. Must be provided.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperimentRun(projectId, experimentId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.
            var runId = runId_example;  // String | ID of the ExperimentRun to fetch. Must be provided.

            try
            {
                // Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
                ExperimentRun result = apiInstance.getExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.
$runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.

try {
    $result = $api_instance->getExperimentRun($projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.
my $runId = runId_example; # String | ID of the ExperimentRun to fetch. Must be provided.

eval { 
    my $result = $api_instance->getExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.
runId = runId_example # String | ID of the ExperimentRun to fetch. Must be provided.

try: 
    # Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
    api_response = api_instance.get_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required
run_id*
String
ID of the ExperimentRun to fetch. Must be provided.
Required

Responses

Status: 200 - A successful response.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location (relative to the experiment run's root artifact directory) and metadata for artifacts.

{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}
]
registered_model_metadata:
[

RegisteredModelMetadata is used to show what model version is registered for this model.

{

RegisteredModelMetadata is used to represent model version metadata.

model_path:
string

model_path artifact folder name.

model_name:
string

model_name.

model_id:
string

model_id of the registered model id.

model_version_id:
string

model_version_id of the.

version_number:
integer (int32)

count of the model version.

run_id:
string

run_id of the experiment run.

created_at:
string (date-time)

created_at timestamp of model registered.

}
]
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getExperimentRunMetrics

Gets the all the recorded metrics for the key for a given run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}/metrics/{metric_key}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}/metrics/{metric_key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Project ID
        String experimentId = experimentId_example; // String | Experiment ID the run belongs to
        String runId = runId_example; // String | ID of the ExperimentRun
        String metricKey = metricKey_example; // String | metric key name.
        try {
            GetExperimentRunMetricsResponse result = apiInstance.getExperimentRunMetrics(projectId, experimentId, runId, metricKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRunMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Project ID
        String experimentId = experimentId_example; // String | Experiment ID the run belongs to
        String runId = runId_example; // String | ID of the ExperimentRun
        String metricKey = metricKey_example; // String | metric key name.
        try {
            GetExperimentRunMetricsResponse result = apiInstance.getExperimentRunMetrics(projectId, experimentId, runId, metricKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRunMetrics");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // Project ID
String *experimentId = experimentId_example; // Experiment ID the run belongs to
String *runId = runId_example; // ID of the ExperimentRun
String *metricKey = metricKey_example; // metric key name.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Gets the all the recorded metrics for the key for a given run.
[apiInstance getExperimentRunMetricsWith:projectId
    experimentId:experimentId
    runId:runId
    metricKey:metricKey
              completionHandler: ^(GetExperimentRunMetricsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} Project ID
var experimentId = experimentId_example; // {{String}} Experiment ID the run belongs to
var runId = runId_example; // {{String}} ID of the ExperimentRun
var metricKey = metricKey_example; // {{String}} metric key name.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperimentRunMetrics(projectId, experimentId, runId, metricKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExperimentRunMetricsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | Project ID
            var experimentId = experimentId_example;  // String | Experiment ID the run belongs to
            var runId = runId_example;  // String | ID of the ExperimentRun
            var metricKey = metricKey_example;  // String | metric key name.

            try
            {
                // Gets the all the recorded metrics for the key for a given run.
                GetExperimentRunMetricsResponse result = apiInstance.getExperimentRunMetrics(projectId, experimentId, runId, metricKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getExperimentRunMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | Project ID
$experimentId = experimentId_example; // String | Experiment ID the run belongs to
$runId = runId_example; // String | ID of the ExperimentRun
$metricKey = metricKey_example; // String | metric key name.

try {
    $result = $api_instance->getExperimentRunMetrics($projectId, $experimentId, $runId, $metricKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getExperimentRunMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | Project ID
my $experimentId = experimentId_example; # String | Experiment ID the run belongs to
my $runId = runId_example; # String | ID of the ExperimentRun
my $metricKey = metricKey_example; # String | metric key name.

eval { 
    my $result = $api_instance->getExperimentRunMetrics(projectId => $projectId, experimentId => $experimentId, runId => $runId, metricKey => $metricKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getExperimentRunMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | Project ID
experimentId = experimentId_example # String | Experiment ID the run belongs to
runId = runId_example # String | ID of the ExperimentRun
metricKey = metricKey_example # String | metric key name.

try: 
    # Gets the all the recorded metrics for the key for a given run.
    api_response = api_instance.get_experiment_run_metrics(projectId, experimentId, runId, metricKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getExperimentRunMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
experiment_id*
String
Experiment ID the run belongs to
Required
run_id*
String
ID of the ExperimentRun
Required
metric_key*
String
metric key name.
Required

Responses

Status: 200 - A successful response.

GetExperimentRunMetricsResponse returns all the metrics for a given value {
metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getJob

Return one job.


/api/v2/projects/{project_id}/jobs/{job_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            Job result = apiInstance.getJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            Job result = apiInstance.getJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJob");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *jobId = jobId_example; // The public job identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return one job.
[apiInstance getJobWith:projectId
    jobId:jobId
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var jobId = jobId_example; // {{String}} The public job identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJob(projectId, jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var jobId = jobId_example;  // String | The public job identifier

            try
            {
                // Return one job.
                Job result = apiInstance.getJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$jobId = jobId_example; // String | The public job identifier

try {
    $result = $api_instance->getJob($projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $jobId = jobId_example; # String | The public job identifier

eval { 
    my $result = $api_instance->getJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
jobId = jobId_example # String | The public job identifier

try: 
    # Return one job.
    api_response = api_instance.get_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
job_id*
String
The public job identifier
Required

Responses

Status: 200 - A successful response.

{

One Job.

id:
string

Public identifier of the job. Output only.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created. Output only.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes. Output only.

english_schedule:
string

English schedule. Output only.

arguments:
string

Arguments to the job.

type:
string

Type of job, whether it's "manual", "cron", or "dependent" Output only.

kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused. Output only.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job if this is a scheduled job. Output only.

updated_at:
string (date-time)

When the job was last updated. Output only.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
string

The runtime image identifier if this is a runtime job. Will be blank if using engines.

runtime_addon_identifiers:
[

The runtime addons associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill this job when it times out.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getJobRun

Gets a job run.


/api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to get.
        try {
            JobRun result = apiInstance.getJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to get.
        try {
            JobRun result = apiInstance.getJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJobRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // ID of the job containing the job run.
String *runId = runId_example; // ID of the job run to get.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Gets a job run.
[apiInstance getJobRunWith:projectId
    jobId:jobId
    runId:runId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} ID of the job containing the job run.
var runId = runId_example; // {{String}} ID of the job run to get.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobRun(projectId, jobId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | ID of the job containing the job run.
            var runId = runId_example;  // String | ID of the job run to get.

            try
            {
                // Gets a job run.
                JobRun result = apiInstance.getJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | ID of the job containing the job run.
$runId = runId_example; // String | ID of the job run to get.

try {
    $result = $api_instance->getJobRun($projectId, $jobId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | ID of the job containing the job run.
my $runId = runId_example; # String | ID of the job run to get.

eval { 
    my $result = $api_instance->getJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | ID of the job containing the job run.
runId = runId_example # String | ID of the job run to get.

try: 
    # Gets a job run.
    api_response = api_instance.get_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
ID of the job containing the job run.
Required
run_id*
String
ID of the job run to get.
Required

Responses

Status: 200 - A successful response.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getModel

Get a model.


/api/v2/projects/{project_id}/models/{model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String modelId = modelId_example; // String | The model's ID
        try {
            Model result = apiInstance.getModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String modelId = modelId_example; // String | The model's ID
        try {
            Model result = apiInstance.getModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModel");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
String *modelId = modelId_example; // The model's ID

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a model.
[apiInstance getModelWith:projectId
    modelId:modelId
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var modelId = modelId_example; // {{String}} The model's ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModel(projectId, modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var modelId = modelId_example;  // String | The model's ID

            try
            {
                // Get a model.
                Model result = apiInstance.getModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$modelId = modelId_example; // String | The model's ID

try {
    $result = $api_instance->getModel($projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $modelId = modelId_example; # String | The model's ID

eval { 
    my $result = $api_instance->getModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
modelId = modelId_example # String | The model's ID

try: 
    # Get a model.
    api_response = api_instance.get_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
model_id*
String
The model's ID
Required

Responses

Status: 200 - A successful response.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
registered_model_id:
string

Registered Model ID reference to model Regisry.

visibility:
string

Visibility of the model.

default_resources:
Details of a model's default resources {
cpu_millicores:
New number of cpu millicores for the model string (int64)
memory_mb:
New number of memory (in MB) for the model string (int64)
nvidia_gpus:
New number of Nvidia GPUs for the model string (int64)
}
default_replication_policy:
Details of a model's default replication policy {
num_replicas:
Number of replicas to use for the model string (int64)
type:
Type of replication to use (i.e. fixed) string
}
run_as:
userID of the service account that should be used to create/deploy the model When it is empty, creator's userID is used integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getModelBuild

Get a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}?registered_model_version_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the model build to get.
        String registeredModelVersionId = registeredModelVersionId_example; // String | ID of the registered model version.
        try {
            ModelBuild result = apiInstance.getModelBuild(projectId, modelId, buildId, registeredModelVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the model build to get.
        String registeredModelVersionId = registeredModelVersionId_example; // String | ID of the registered model version.
        try {
            ModelBuild result = apiInstance.getModelBuild(projectId, modelId, buildId, registeredModelVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelBuild");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the build.
String *buildId = buildId_example; // ID of the model build to get.
String *registeredModelVersionId = registeredModelVersionId_example; // ID of the registered model version. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a model build.
[apiInstance getModelBuildWith:projectId
    modelId:modelId
    buildId:buildId
    registeredModelVersionId:registeredModelVersionId
              completionHandler: ^(ModelBuild output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the build.
var buildId = buildId_example; // {{String}} ID of the model build to get.
var opts = { 
  'registeredModelVersionId': registeredModelVersionId_example // {{String}} ID of the registered model version.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelBuild(projectId, modelId, buildId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getModelBuildExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the build.
            var buildId = buildId_example;  // String | ID of the model build to get.
            var registeredModelVersionId = registeredModelVersionId_example;  // String | ID of the registered model version. (optional) 

            try
            {
                // Get a model build.
                ModelBuild result = apiInstance.getModelBuild(projectId, modelId, buildId, registeredModelVersionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the build.
$buildId = buildId_example; // String | ID of the model build to get.
$registeredModelVersionId = registeredModelVersionId_example; // String | ID of the registered model version.

try {
    $result = $api_instance->getModelBuild($projectId, $modelId, $buildId, $registeredModelVersionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getModelBuild: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the build.
my $buildId = buildId_example; # String | ID of the model build to get.
my $registeredModelVersionId = registeredModelVersionId_example; # String | ID of the registered model version.

eval { 
    my $result = $api_instance->getModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId, registeredModelVersionId => $registeredModelVersionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getModelBuild: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the build.
buildId = buildId_example # String | ID of the model build to get.
registeredModelVersionId = registeredModelVersionId_example # String | ID of the registered model version. (optional)

try: 
    # Get a model build.
    api_response = api_instance.get_model_build(projectId, modelId, buildId, registeredModelVersionId=registeredModelVersionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the build.
Required
build_id*
String
ID of the model build to get.
Required
Query parameters
Name Description
registered_model_version_id
String
ID of the registered model version.

Responses

Status: 200 - A successful response.

{

A single model build.

id:
string

ID of the model build.

model_id:
string

ID of the model containing the build.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
comment:
string

The comment associated with the build.

file_path:
string

Path from the project root to the file to build.

function_name:
string

Name of the function to run.

engine_image:
string

The engine image to build the model with.

kernel:
string

The kernel to run the build with.

created_at:
string (date-time)

When the model build was created.

updated_at:
string (date-time)

When the model build was most recently updated.

status:
string

Status of the build.

deletion_status:
string

State of the deletion of the build.

crn:
string

CRN of the build.

built_at:
string (date-time)

When the model build was most recently updated.

runtime_identifier:
string

Runtime identifier if this model uses runtimes.

runtime_addon_identifiers:
[

Runtime addons if this model uses runtimes.

string
]
registered_model_version_id:
string

ID of the registered model version.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getModelDeployment

Get a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the model build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the model deployment to get.
        try {
            ModelDeployment result = apiInstance.getModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the model build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the model deployment to get.
        try {
            ModelDeployment result = apiInstance.getModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the model build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the model deployment to get.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a model deployment.
[apiInstance getModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the model build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the model deployment to get.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelDeployment(projectId, modelId, buildId, deploymentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the model build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the model deployment to get.

            try
            {
                // Get a model deployment.
                ModelDeployment result = apiInstance.getModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the model build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the model deployment to get.

try {
    $result = $api_instance->getModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the model build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the model deployment to get.

eval { 
    my $result = $api_instance->getModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the model build containing the deployment.
deploymentId = deploymentId_example # String | ID of the model deployment to get.

try: 
    # Get a model deployment.
    api_response = api_instance.get_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the model build containing the deployment.
Required
deployment_id*
String
ID of the model deployment to get.
Required

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

replicas:
integer (int32)

Number of Replicas.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getProject

Return one project.


/api/v2/projects/{project_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8
        try {
            Project result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8
        try {
            Project result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return one project.
[apiInstance getProjectWith:projectId
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

            try
            {
                // Return one project.
                Project result = apiInstance.getProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

try {
    $result = $api_instance->getProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

eval { 
    my $result = $api_instance->getProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

try: 
    # Return one project.
    api_response = api_instance.get_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getProject: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Identifier for a project, in the form of a 19 digit string. Example: a1b2-c3d4-e5f6-g7h8
Required

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

inherit:
boolean (boolean)

inherit is meant to be used only for teams.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getRegisteredModel

Get a registered model.


/api/v2/registry/models/{model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            RegisteredModel result = apiInstance.getRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            RegisteredModel result = apiInstance.getRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModel");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a registered model.
[apiInstance getRegisteredModelWith:modelId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(RegisteredModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegisteredModel(modelId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Get a registered model.
                RegisteredModel result = apiInstance.getRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->getRegisteredModel($modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->getRegisteredModel(modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Get a registered model.
    api_response = api_instance.get_registered_model(modelId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getRegisteredModel: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filters: earch_filter = {"version_number":"3"} search_filter = {"creator_id":"<sso name or user name>"} example: csso_mlengineer.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. : supported sort=-created_at supported sort=-versions.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{
model_id:
string

Model ID.

name:
string

Model name.

description:
string

Model description.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
permission:
string

Permission of the user requesting the model.

visibility:
string
Default: PRIVATE
Enum: PRIVATE, PUBLIC
created_at:
string (date-time)

Model creation time.

updated_at:
string (date-time)

Model last updated time.

count:
integer (int32)

Model version count.

model_versions:
[

Registered model versions list.

{

RegisteredModelVersion is a model version.

model_id:
string

Model ID.

model_version_id:
string

Model version ID.

version_name:
string

Model version name.

number:
integer (int32)

Model version number.

notes:
string

Model version description.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
created_at:
string (date-time)

Model version creation time.

updated_at:
string (date-time)

Model version last updated time.

status:
string

Model version status.

model_version_metadata:
{

ModelVersionMetadata is a model version metadata.

mlops_type:
string
Default: MLFLOW
Enum: MLFLOW, SIMPLE
tags:
[

tags for model.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
workspace_url:
string

Workspace URL to track back the model origins.

project_id:
string

Project ID.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
mlflow_metadata:
{

MLflowMetadata is an mlflow model metadata.

experiment_id:
string

Experiment ID the run belongs to.

run_id:
string

Run ID.

metrics:
[

Metrics for the run.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
simple_metadata:
{

SimpleMetadata is a simple model metadata.

git_url:
string

git url for model code.

commit_id:
string

commit sha for model code.

metrics:
[

metrics for the model.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
}
tags:
[

Model version tags.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
]
next_page_token:
string

next_page_token is a token to get the next page of results.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getRegisteredModelVersion

Get a registered model version


/api/v2/registry/models/{model_id}/versions/{version_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}/versions/{version_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            RegisteredModelVersion result = apiInstance.getRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            RegisteredModelVersion result = apiInstance.getRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.
String *versionId = versionId_example; // Model version ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a registered model version
[apiInstance getRegisteredModelVersionWith:modelId
    versionId:versionId
              completionHandler: ^(RegisteredModelVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.
var versionId = versionId_example; // {{String}} Model version ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegisteredModelVersion(modelId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegisteredModelVersionExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.
            var versionId = versionId_example;  // String | Model version ID.

            try
            {
                // Get a registered model version
                RegisteredModelVersion result = apiInstance.getRegisteredModelVersion(modelId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getRegisteredModelVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.
$versionId = versionId_example; // String | Model version ID.

try {
    $result = $api_instance->getRegisteredModelVersion($modelId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getRegisteredModelVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.
my $versionId = versionId_example; # String | Model version ID.

eval { 
    my $result = $api_instance->getRegisteredModelVersion(modelId => $modelId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getRegisteredModelVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.
versionId = versionId_example # String | Model version ID.

try: 
    # Get a registered model version
    api_response = api_instance.get_registered_model_version(modelId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getRegisteredModelVersion: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
version_id*
String
Model version ID.
Required

Responses

Status: 200 - A successful response.

{

RegisteredModelVersion is a model version.

model_id:
string

Model ID.

model_version_id:
string

Model version ID.

version_name:
string

Model version name.

number:
integer (int32)

Model version number.

notes:
string

Model version description.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
created_at:
string (date-time)

Model version creation time.

updated_at:
string (date-time)

Model version last updated time.

status:
string

Model version status.

model_version_metadata:
{

ModelVersionMetadata is a model version metadata.

mlops_type:
string
Default: MLFLOW
Enum: MLFLOW, SIMPLE
tags:
[

tags for model.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
workspace_url:
string

Workspace URL to track back the model origins.

project_id:
string

Project ID.

owner:
{

Abbreviated user information.

username:
name:
email:
}
mlflow_metadata:
{

MLflowMetadata is an mlflow model metadata.

experiment_id:
run_id:
metrics:
params:
tags:
}
simple_metadata:
{

SimpleMetadata is a simple model metadata.

git_url:
commit_id:
metrics:
params:
tags:
}
}
tags:
[

Model version tags.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getShortUserByID


/api/v2/users/{user_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/users/{user_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer userId = 56; // Integer | 
        try {
            ShortUser result = apiInstance.getShortUserByID(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getShortUserByID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer userId = 56; // Integer | 
        try {
            ShortUser result = apiInstance.getShortUserByID(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getShortUserByID");
            e.printStackTrace();
        }
    }
}
Integer *userId = 56; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

[apiInstance getShortUserByIDWith:userId
              completionHandler: ^(ShortUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var userId = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShortUserByID(userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShortUserByIDExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var userId = 56;  // Integer | 

            try
            {
                ShortUser result = apiInstance.getShortUserByID(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getShortUserByID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$userId = 56; // Integer | 

try {
    $result = $api_instance->getShortUserByID($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getShortUserByID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $userId = 56; # Integer | 

eval { 
    my $result = $api_instance->getShortUserByID(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getShortUserByID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
userId = 56 # Integer | 

try: 
    api_response = api_instance.get_short_user_by_id(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getShortUserByID: %s\n" % e)

Parameters

Path parameters
Name Description
user_id*
Integer (int32)
Required

Responses

Status: 200 - A successful response.

{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

getTimeSeries

Return the time series data for the requested resource or property.


/api/v2/ts_data

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/ts_data?search_filter=&page_token=&multi_column_search_filter=&time_range_search_filter=&series_type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        String seriesType = seriesType_example; // String | Type of the time series.
Supported values are [cpu, memory, gpu].
        try {
            TimeSeriesResponse result = apiInstance.getTimeSeries(searchFilter, pageToken, multiColumnSearchFilter, timeRangeSearchFilter, seriesType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getTimeSeries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        String seriesType = seriesType_example; // String | Type of the time series.
Supported values are [cpu, memory, gpu].
        try {
            TimeSeriesResponse result = apiInstance.getTimeSeries(searchFilter, pageToken, multiColumnSearchFilter, timeRangeSearchFilter, seriesType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getTimeSeries");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *multiColumnSearchFilter = multiColumnSearchFilter_example; // Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
String *timeRangeSearchFilter = timeRangeSearchFilter_example; // Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)
String *seriesType = seriesType_example; // Type of the time series.
Supported values are [cpu, memory, gpu]. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return the time series data for the requested resource or property.
[apiInstance getTimeSeriesWith:searchFilter
    pageToken:pageToken
    multiColumnSearchFilter:multiColumnSearchFilter
    timeRangeSearchFilter:timeRangeSearchFilter
    seriesType:seriesType
              completionHandler: ^(TimeSeriesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'multiColumnSearchFilter': multiColumnSearchFilter_example, // {{String}} Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
  'timeRangeSearchFilter': timeRangeSearchFilter_example, // {{String}} Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
  'seriesType': seriesType_example // {{String}} Type of the time series.
Supported values are [cpu, memory, gpu].
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTimeSeries(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTimeSeriesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var multiColumnSearchFilter = multiColumnSearchFilter_example;  // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional) 
            var timeRangeSearchFilter = timeRangeSearchFilter_example;  // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional) 
            var seriesType = seriesType_example;  // String | Type of the time series.
Supported values are [cpu, memory, gpu]. (optional) 

            try
            {
                // Return the time series data for the requested resource or property.
                TimeSeriesResponse result = apiInstance.getTimeSeries(searchFilter, pageToken, multiColumnSearchFilter, timeRangeSearchFilter, seriesType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getTimeSeries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
$timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
$seriesType = seriesType_example; // String | Type of the time series.
Supported values are [cpu, memory, gpu].

try {
    $result = $api_instance->getTimeSeries($searchFilter, $pageToken, $multiColumnSearchFilter, $timeRangeSearchFilter, $seriesType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getTimeSeries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $multiColumnSearchFilter = multiColumnSearchFilter_example; # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
my $timeRangeSearchFilter = timeRangeSearchFilter_example; # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
my $seriesType = seriesType_example; # String | Type of the time series.
Supported values are [cpu, memory, gpu].

eval { 
    my $result = $api_instance->getTimeSeries(searchFilter => $searchFilter, pageToken => $pageToken, multiColumnSearchFilter => $multiColumnSearchFilter, timeRangeSearchFilter => $timeRangeSearchFilter, seriesType => $seriesType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getTimeSeries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
multiColumnSearchFilter = multiColumnSearchFilter_example # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
timeRangeSearchFilter = timeRangeSearchFilter_example # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)
seriesType = seriesType_example # String | Type of the time series.
Supported values are [cpu, memory, gpu]. (optional)

try: 
    # Return the time series data for the requested resource or property.
    api_response = api_instance.get_time_series(searchFilter=searchFilter, pageToken=pageToken, multiColumnSearchFilter=multiColumnSearchFilter, timeRangeSearchFilter=timeRangeSearchFilter, seriesType=seriesType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getTimeSeries: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [name creator group project_name workload_type status]. For example: search_filter={"name":"My Session","workload_type":"session"}.
page_token
String
page token for specifying which page to return.
multi_column_search_filter
String
Multi column search filter is an optional HTTP parameter to filter multiple columns. Supported Multi column search filter keys are: [project_or_workload_name]. For example: multi_column_search_filter={"project_or_workload_name":"name"}.
time_range_search_filter
String
Time range search filter is an optional HTTP parameter to filter based on the time. Supported Time range search filters are: [created_time]. For example: time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
series_type
String
Type of the time series. Supported values are [cpu, memory, gpu].

Responses

Status: 200 - A successful response.

Response object for time series data {
series_type:
string

Type of the time series.

result:
Time series result {
values:
Result of the time series query[
Time series result values {
time_stamp:
timestamp string (uint64)
count:
count string (uint64)
}
]
}
next_page_token:
string

Next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

handleCustomRuntimeUpload

Create a new Custom Runtime Addon from an uploaded tarball


/api/v2/runtimeaddons/custom

Usage and SDK Samples

curl -X POST\
-H "Content-Type: multipart/form-data"\
"//api/v2/runtimeaddons/custom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        byte[] metadata = metadata_example; // byte[] | 
        byte[] tarball = tarball_example; // byte[] | 
        try {
            apiInstance.handleCustomRuntimeUpload(metadata, tarball);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#handleCustomRuntimeUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        byte[] metadata = metadata_example; // byte[] | 
        byte[] tarball = tarball_example; // byte[] | 
        try {
            apiInstance.handleCustomRuntimeUpload(metadata, tarball);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#handleCustomRuntimeUpload");
            e.printStackTrace();
        }
    }
}
byte[] *metadata = metadata_example; // 
byte[] *tarball = tarball_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new Custom Runtime Addon from an uploaded tarball
[apiInstance handleCustomRuntimeUploadWith:metadata
    tarball:tarball
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var metadata = metadata_example; // {{byte[]}} 
var tarball = tarball_example; // {{byte[]}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.handleCustomRuntimeUpload(metadatatarball, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleCustomRuntimeUploadExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var metadata = metadata_example;  // byte[] | 
            var tarball = tarball_example;  // byte[] | 

            try
            {
                // Create a new Custom Runtime Addon from an uploaded tarball
                apiInstance.handleCustomRuntimeUpload(metadata, tarball);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.handleCustomRuntimeUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$metadata = metadata_example; // byte[] | 
$tarball = tarball_example; // byte[] | 

try {
    $api_instance->handleCustomRuntimeUpload($metadata, $tarball);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->handleCustomRuntimeUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $metadata = metadata_example; # byte[] | 
my $tarball = tarball_example; # byte[] | 

eval { 
    $api_instance->handleCustomRuntimeUpload(metadata => $metadata, tarball => $tarball);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->handleCustomRuntimeUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
metadata = metadata_example # byte[] | 
tarball = tarball_example # byte[] | 

try: 
    # Create a new Custom Runtime Addon from an uploaded tarball
    api_instance.handle_custom_runtime_upload(metadata, tarball)
except ApiException as e:
    print("Exception when calling CMLServiceApi->handleCustomRuntimeUpload: %s\n" % e)

Parameters

Form parameters
Name Description
metadata*
byte[] (binary)
Required
tarball*
byte[] (binary)
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response.

listAcceleratorBasedUserQuota

List all Accelerator based quota for user


/api/v2/nodelabels/quota

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/nodelabels/quota?search_filter=&sort=&page_size=&page_token=&display_all="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id].
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response accelerator based user quota.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        Boolean displayAll = true; // Boolean | set the below to true to display all GPUs, even those which do not have quota set.
        try {
            ListAcceleratorBasedUserQuotaResponse result = apiInstance.listAcceleratorBasedUserQuota(searchFilter, sort, pageSize, pageToken, displayAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAcceleratorBasedUserQuota");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id].
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response accelerator based user quota.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        Boolean displayAll = true; // Boolean | set the below to true to display all GPUs, even those which do not have quota set.
        try {
            ListAcceleratorBasedUserQuotaResponse result = apiInstance.listAcceleratorBasedUserQuota(searchFilter, sort, pageSize, pageToken, displayAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAcceleratorBasedUserQuota");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id. (optional)
Integer *pageSize = 56; // page size of the response accelerator based user quota. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
Boolean *displayAll = true; // set the below to true to display all GPUs, even those which do not have quota set. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all Accelerator based quota for user
[apiInstance listAcceleratorBasedUserQuotaWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    displayAll:displayAll
              completionHandler: ^(ListAcceleratorBasedUserQuotaResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id].
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id.
  'pageSize': 56, // {{Integer}} page size of the response accelerator based user quota.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'displayAll': true // {{Boolean}} set the below to true to display all GPUs, even those which do not have quota set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAcceleratorBasedUserQuota(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAcceleratorBasedUserQuotaExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id. (optional) 
            var pageSize = 56;  // Integer | page size of the response accelerator based user quota. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var displayAll = true;  // Boolean | set the below to true to display all GPUs, even those which do not have quota set. (optional) 

            try
            {
                // List all Accelerator based quota for user
                ListAcceleratorBasedUserQuotaResponse result = apiInstance.listAcceleratorBasedUserQuota(searchFilter, sort, pageSize, pageToken, displayAll);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAcceleratorBasedUserQuota: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id].
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id.
$pageSize = 56; // Integer | page size of the response accelerator based user quota.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$displayAll = true; // Boolean | set the below to true to display all GPUs, even those which do not have quota set.

try {
    $result = $api_instance->listAcceleratorBasedUserQuota($searchFilter, $sort, $pageSize, $pageToken, $displayAll);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAcceleratorBasedUserQuota: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id].
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id.
my $pageSize = 56; # Integer | page size of the response accelerator based user quota.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $displayAll = true; # Boolean | set the below to true to display all GPUs, even those which do not have quota set.

eval { 
    my $result = $api_instance->listAcceleratorBasedUserQuota(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, displayAll => $displayAll);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAcceleratorBasedUserQuota: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [user_id accelerator_id].
  sort=id. (optional)
pageSize = 56 # Integer | page size of the response accelerator based user quota. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
displayAll = true # Boolean | set the below to true to display all GPUs, even those which do not have quota set. (optional)

try: 
    # List all Accelerator based quota for user
    api_response = api_instance.list_accelerator_based_user_quota(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, displayAll=displayAll)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAcceleratorBasedUserQuota: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [user_id accelerator_id].
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [user_id accelerator_id]. sort=id.
page_size
Integer (int32)
page size of the response accelerator based user quota.
page_token
String
page token for specifying which page to return.
display_all
Boolean (boolean)
set the below to true to display all GPUs, even those which do not have quota set.

Responses

Status: 200 - A successful response.

{
accelerator_based_user_quota:
[
{
user_id:
string (int64)
accelerator_id:
string (int64)
gpu_quota:
string
accelerator_key:
string
accelerator_value:
string
}
]
next_page_token:
string

A token to fetch the next page of accelerator node labels.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listAllAcceleratorNodeLabels

List all Accelerator Node Label


/api/v2/nodelabels

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/nodelabels?search_filter=&sort=&page_size=&page_token=&display_all="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key].
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response accelerator node labels list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        Boolean displayAll = true; // Boolean | set the below to true to display all GPUs, even those which are inactive.
        try {
            ListAllAcceleratorsNodeLabelsResponse result = apiInstance.listAllAcceleratorNodeLabels(searchFilter, sort, pageSize, pageToken, displayAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllAcceleratorNodeLabels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key].
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response accelerator node labels list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        Boolean displayAll = true; // Boolean | set the below to true to display all GPUs, even those which are inactive.
        try {
            ListAllAcceleratorsNodeLabelsResponse result = apiInstance.listAllAcceleratorNodeLabels(searchFilter, sort, pageSize, pageToken, displayAll);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllAcceleratorNodeLabels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key]. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id. (optional)
Integer *pageSize = 56; // page size of the response accelerator node labels list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
Boolean *displayAll = true; // set the below to true to display all GPUs, even those which are inactive. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all Accelerator Node Label
[apiInstance listAllAcceleratorNodeLabelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    displayAll:displayAll
              completionHandler: ^(ListAllAcceleratorsNodeLabelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key].
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
  'pageSize': 56, // {{Integer}} page size of the response accelerator node labels list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'displayAll': true // {{Boolean}} set the below to true to display all GPUs, even those which are inactive.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllAcceleratorNodeLabels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllAcceleratorNodeLabelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key]. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id. (optional) 
            var pageSize = 56;  // Integer | page size of the response accelerator node labels list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var displayAll = true;  // Boolean | set the below to true to display all GPUs, even those which are inactive. (optional) 

            try
            {
                // List all Accelerator Node Label
                ListAllAcceleratorsNodeLabelsResponse result = apiInstance.listAllAcceleratorNodeLabels(searchFilter, sort, pageSize, pageToken, displayAll);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllAcceleratorNodeLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key].
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
$pageSize = 56; // Integer | page size of the response accelerator node labels list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$displayAll = true; // Boolean | set the below to true to display all GPUs, even those which are inactive.

try {
    $result = $api_instance->listAllAcceleratorNodeLabels($searchFilter, $sort, $pageSize, $pageToken, $displayAll);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllAcceleratorNodeLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key].
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
my $pageSize = 56; # Integer | page size of the response accelerator node labels list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $displayAll = true; # Boolean | set the below to true to display all GPUs, even those which are inactive.

eval { 
    my $result = $api_instance->listAllAcceleratorNodeLabels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, displayAll => $displayAll);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllAcceleratorNodeLabels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key]. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id. (optional)
pageSize = 56 # Integer | page size of the response accelerator node labels list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
displayAll = true # Boolean | set the below to true to display all GPUs, even those which are inactive. (optional)

try: 
    # List all Accelerator Node Label
    api_response = api_instance.list_all_accelerator_node_labels(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, displayAll=displayAll)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllAcceleratorNodeLabels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [id label_key].
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [id label_key]. sort=id.
page_size
Integer (int32)
page size of the response accelerator node labels list.
page_token
String
page token for specifying which page to return.
display_all
Boolean (boolean)
set the below to true to display all GPUs, even those which are inactive.

Responses

Status: 200 - A successful response.

{
accelerator_node_label:
[
{
id:
string (int64)
label_key:
string
label_value:
string
availability:
boolean (boolean)
max_gpu_count:
string (int64)
current_gpu_count:
string (int64)
max_gpu_per_workload:
string (int64)
created_at:
string (date-time)
updated_at:
string (date-time)
default_quota:
string (int64)
}
]
next_page_token:
string

A token to fetch the next page of accelerator node labels.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listAllExperiments

Lists all experiments that belong to a user across all projects.


/api/v2/experiments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/experiments?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListExperimentsResponse result = apiInstance.listAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListExperimentsResponse result = apiInstance.listAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllExperiments");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Lists all experiments that belong to a user across all projects.
[apiInstance listAllExperimentsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListExperimentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllExperiments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllExperimentsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Lists all experiments that belong to a user across all projects.
                ListExperimentsResponse result = apiInstance.listAllExperiments(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listAllExperiments($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllExperiments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listAllExperiments(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllExperiments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Lists all experiments that belong to a user across all projects.
    api_response = api_instance.list_all_experiments(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllExperiments: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

ListExperimentsResponse containes array of experiment objects {
experiments:
[
{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listAllJobs

Returns all jobs a user has access to.


/api/v2/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/jobs?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listAllJobs(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listAllJobs(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllJobs");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Returns all jobs a user has access to.
[apiInstance listAllJobsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllJobs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllJobsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Returns all jobs a user has access to.
                ListJobsResponse result = apiInstance.listAllJobs(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listAllJobs($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listAllJobs(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Returns all jobs a user has access to.
    api_response = api_instance.list_all_jobs(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllJobs: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type]. For example: search_filter={"name":"foo","creator.name":"bar"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of jobs.

jobs:
[

Jobs is the response object with details on a list of jobs.

{

One Job.

id:
string

Public identifier of the job. Output only.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created. Output only.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes. Output only.

english_schedule:
string

English schedule. Output only.

arguments:
string

Arguments to the job.

type:
string

Type of job, whether it's "manual", "cron", or "dependent" Output only.

kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused. Output only.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job if this is a scheduled job. Output only.

updated_at:
string (date-time)

When the job was last updated. Output only.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
string

The runtime image identifier if this is a runtime job. Will be blank if using engines.

runtime_addon_identifiers:
[

The runtime addons associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill this job when it times out.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listAllModels

List all models that belong to a user across all projects.


/api/v2/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/models?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListModelsResponse result = apiInstance.listAllModels(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListModelsResponse result = apiInstance.listAllModels(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; //  (optional)
Integer *pageSize = 56; //  (optional)
String *pageToken = pageToken_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all models that belong to a user across all projects.
[apiInstance listAllModelsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} 
  'pageSize': 56, // {{Integer}} 
  'pageToken': pageToken_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String |  (optional) 
            var pageSize = 56;  // Integer |  (optional) 
            var pageToken = pageToken_example;  // String |  (optional) 

            try
            {
                // List all models that belong to a user across all projects.
                ListModelsResponse result = apiInstance.listAllModels(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | 
$pageSize = 56; // Integer | 
$pageToken = pageToken_example; // String | 

try {
    $result = $api_instance->listAllModels($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | 
my $pageSize = 56; # Integer | 
my $pageToken = pageToken_example; # String | 

eval { 
    my $result = $api_instance->listAllModels(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String |  (optional)
pageSize = 56 # Integer |  (optional)
pageToken = pageToken_example # String |  (optional)

try: 
    # List all models that belong to a user across all projects.
    api_response = api_instance.list_all_models(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllModels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
page_size
Integer (int32)
page_token
String

Responses

Status: 200 - A successful response.

{

Response for listing models.

models:
[

The models in this page.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
registered_model_id:
string

Registered Model ID reference to model Regisry.

visibility:
string

Visibility of the model.

default_resources:
Details of a model's default resources {
cpu_millicores:
New number of cpu millicores for the model string (int64)
memory_mb:
New number of memory (in MB) for the model string (int64)
nvidia_gpus:
New number of Nvidia GPUs for the model string (int64)
}
default_replication_policy:
Details of a model's default replication policy {
num_replicas:
Number of replicas to use for the model string (int64)
type:
Type of replication to use (i.e. fixed) string
}
run_as:
userID of the service account that should be used to create/deploy the model When it is empty, creator's userID is used integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}
]
next_page_token:
string

The page token for the next page.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listAllRunAsMachineUserCollaborators


/api/v2/projects/{project_id}/machineusers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/machineusers?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListAllRunAsMachineUserCollaboratorsResponse result = apiInstance.listAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllRunAsMachineUserCollaborators");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListAllRunAsMachineUserCollaboratorsResponse result = apiInstance.listAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllRunAsMachineUserCollaborators");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

[apiInstance listAllRunAsMachineUserCollaboratorsWith:projectId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListAllRunAsMachineUserCollaboratorsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllRunAsMachineUserCollaborators(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllRunAsMachineUserCollaboratorsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional) 

            try
            {
                ListAllRunAsMachineUserCollaboratorsResponse result = apiInstance.listAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllRunAsMachineUserCollaborators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

try {
    $result = $api_instance->listAllRunAsMachineUserCollaborators($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllRunAsMachineUserCollaborators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

eval { 
    my $result = $api_instance->listAllRunAsMachineUserCollaborators(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllRunAsMachineUserCollaborators: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

try: 
    api_response = api_instance.list_all_run_as_machine_user_collaborators(projectId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllRunAsMachineUserCollaborators: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: []. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=.

Responses

Status: 200 - A successful response.

{
run_as_machine_user_collaborators:
[
{
user_id:
integer (int32)
user_name:
string
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListProjectCollaborators call to fetch the next page of projects, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listApplications

List applications, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/applications

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListApplicationsResponse result = apiInstance.listApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListApplicationsResponse result = apiInstance.listApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listApplications");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List applications, optionally filtered, sorted, and paginated.
[apiInstance listApplicationsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListApplicationsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listApplications(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listApplicationsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List applications, optionally filtered, sorted, and paginated.
                ListApplicationsResponse result = apiInstance.listApplications(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listApplications($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listApplications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listApplications(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listApplications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project's identifier
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List applications, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_applications(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listApplications: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain] where "status" can be one of the following: [running, stopping, stopped, starting, failed] For example: search_filter = {"status":"running"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of applications.

applications:
applications is a list of application[
{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListApplications call to fetch the next page of projects, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listCopilotEmbeddingModels

List Copilot embedding models, optionally filtered, sorted, and paginated.


/api/v2/copilot/embedding_models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/copilot/embedding_models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
        Integer pageSize = 56; // Integer | Page size of the response Copilot embedding model list.
        String pageToken = pageToken_example; // String | Page token for specifying which page to return.
        try {
            ListCopilotEmbeddingModelsResponse result = apiInstance.listCopilotEmbeddingModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listCopilotEmbeddingModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
        Integer pageSize = 56; // Integer | Page size of the response Copilot embedding model list.
        String pageToken = pageToken_example; // String | Page token for specifying which page to return.
        try {
            ListCopilotEmbeddingModelsResponse result = apiInstance.listCopilotEmbeddingModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listCopilotEmbeddingModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional)
Integer *pageSize = 56; // Page size of the response Copilot embedding model list. (optional)
String *pageToken = pageToken_example; // Page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List Copilot embedding models, optionally filtered, sorted, and
paginated.
[apiInstance listCopilotEmbeddingModelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListCopilotEmbeddingModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
  'pageSize': 56, // {{Integer}} Page size of the response Copilot embedding model list.
  'pageToken': pageToken_example // {{String}} Page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCopilotEmbeddingModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCopilotEmbeddingModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional) 
            var pageSize = 56;  // Integer | Page size of the response Copilot embedding model list. (optional) 
            var pageToken = pageToken_example;  // String | Page token for specifying which page to return. (optional) 

            try
            {
                // List Copilot embedding models, optionally filtered, sorted, and
paginated.
                ListCopilotEmbeddingModelsResponse result = apiInstance.listCopilotEmbeddingModels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listCopilotEmbeddingModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
$pageSize = 56; // Integer | Page size of the response Copilot embedding model list.
$pageToken = pageToken_example; // String | Page token for specifying which page to return.

try {
    $result = $api_instance->listCopilotEmbeddingModels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listCopilotEmbeddingModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
my $pageSize = 56; # Integer | Page size of the response Copilot embedding model list.
my $pageToken = pageToken_example; # String | Page token for specifying which page to return.

eval { 
    my $result = $api_instance->listCopilotEmbeddingModels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listCopilotEmbeddingModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional)
pageSize = 56 # Integer | Page size of the response Copilot embedding model list. (optional)
pageToken = pageToken_example # String | Page token for specifying which page to return. (optional)

try: 
    # List Copilot embedding models, optionally filtered, sorted, and
paginated.
    api_response = api_instance.list_copilot_embedding_models(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listCopilotEmbeddingModels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [provider name endpoint enabled default provider_id]. For example: search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [provider name endpoint enabled default]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=provider.
page_size
Integer (int32)
Page size of the response Copilot embedding model list.
page_token
String
Page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{

Response for listing Copilot embedding models.

copilot_embedding_models:
[

The copilot models in this page.

Copilot Embedding Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}
]
next_page_token:
string

The page token for the next page.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listCopilotModels

List Copilot models, optionally filtered, sorted, and paginated.


/api/v2/copilot/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/copilot/models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
        Integer pageSize = 56; // Integer | Page size of the response Copilot model list.
        String pageToken = pageToken_example; // String | Page token for specifying which page to return.
        try {
            ListCopilotModelsResponse result = apiInstance.listCopilotModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listCopilotModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
        Integer pageSize = 56; // Integer | Page size of the response Copilot model list.
        String pageToken = pageToken_example; // String | Page token for specifying which page to return.
        try {
            ListCopilotModelsResponse result = apiInstance.listCopilotModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listCopilotModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional)
Integer *pageSize = 56; // Page size of the response Copilot model list. (optional)
String *pageToken = pageToken_example; // Page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List Copilot models, optionally filtered, sorted, and paginated.
[apiInstance listCopilotModelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListCopilotModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
  'pageSize': 56, // {{Integer}} Page size of the response Copilot model list.
  'pageToken': pageToken_example // {{String}} Page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCopilotModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCopilotModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional) 
            var pageSize = 56;  // Integer | Page size of the response Copilot model list. (optional) 
            var pageToken = pageToken_example;  // String | Page token for specifying which page to return. (optional) 

            try
            {
                // List Copilot models, optionally filtered, sorted, and paginated.
                ListCopilotModelsResponse result = apiInstance.listCopilotModels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listCopilotModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
$pageSize = 56; // Integer | Page size of the response Copilot model list.
$pageToken = pageToken_example; // String | Page token for specifying which page to return.

try {
    $result = $api_instance->listCopilotModels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listCopilotModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
my $pageSize = 56; # Integer | Page size of the response Copilot model list.
my $pageToken = pageToken_example; # String | Page token for specifying which page to return.

eval { 
    my $result = $api_instance->listCopilotModels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listCopilotModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default provider_id].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional)
pageSize = 56 # Integer | Page size of the response Copilot model list. (optional)
pageToken = pageToken_example # String | Page token for specifying which page to return. (optional)

try: 
    # List Copilot models, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_copilot_models(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listCopilotModels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [provider name endpoint enabled default provider_id]. For example: search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [provider name endpoint enabled default]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=provider.
page_size
Integer (int32)
Page size of the response Copilot model list.
page_token
String
Page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{

Response for listing Copilot models.

copilot_models:
[

The copilot models in this page.

Copilot Language Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}
]
next_page_token:
string

The page token for the next page.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listDockerCredentials

List Docker credentials.


/api/v2/dockercredentials

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/dockercredentials?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListDockerCredentialsResponse result = apiInstance.listDockerCredentials(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listDockerCredentials");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListDockerCredentialsResponse result = apiInstance.listDockerCredentials(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listDockerCredentials");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List Docker credentials.
[apiInstance listDockerCredentialsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListDockerCredentialsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDockerCredentials(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listDockerCredentialsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List Docker credentials.
                ListDockerCredentialsResponse result = apiInstance.listDockerCredentials(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listDockerCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listDockerCredentials($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listDockerCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listDockerCredentials(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listDockerCredentials: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List Docker credentials.
    api_response = api_instance.list_docker_credentials(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listDockerCredentials: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [id name url]. For example: search_filter={"id":"1","name":"My Repo","url":"my.url"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [id name url]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=id.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{
docker_credentials:
list of Docker Credentials[
{

List* type API calls should not respond with sensitive data, such as username or password. Therefore these API calls will return with this message.

id:
string
name:
string
server:
string
is_default:
boolean (boolean)
}
]
next_page_token:
string

Next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listExperimentRuns

Returns a list of Runs that belong to an experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list experiment runs in.
        String experimentId = experimentId_example; // String | Experiment ID to search over.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.
        try {
            ListExperimentRunsResponse result = apiInstance.listExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperimentRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list experiment runs in.
        String experimentId = experimentId_example; // String | Experiment ID to search over.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.
        try {
            ListExperimentRunsResponse result = apiInstance.listExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperimentRuns");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project to list experiment runs in.
String *experimentId = experimentId_example; // Experiment ID to search over.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params]. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Returns a list of Runs that belong to an experiment.
[apiInstance listExperimentRunsWith:projectId
    experimentId:experimentId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListExperimentRunsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project to list experiment runs in.
var experimentId = experimentId_example; // {{String}} Experiment ID to search over.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listExperimentRuns(projectId, experimentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listExperimentRunsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project to list experiment runs in.
            var experimentId = experimentId_example;  // String | Experiment ID to search over.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params]. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order. (optional) 

            try
            {
                // Returns a list of Runs that belong to an experiment.
                ListExperimentRunsResponse result = apiInstance.listExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listExperimentRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project to list experiment runs in.
$experimentId = experimentId_example; // String | Experiment ID to search over.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.

try {
    $result = $api_instance->listExperimentRuns($projectId, $experimentId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listExperimentRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project to list experiment runs in.
my $experimentId = experimentId_example; # String | Experiment ID to search over.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.

eval { 
    my $result = $api_instance->listExperimentRuns(projectId => $projectId, experimentId => $experimentId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listExperimentRuns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project to list experiment runs in.
experimentId = experimentId_example # String | Experiment ID to search over.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params]. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order. (optional)

try: 
    # Returns a list of Runs that belong to an experiment.
    api_response = api_instance.list_experiment_runs(projectId, experimentId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listExperimentRuns: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project to list experiment runs in.
Required
experiment_id*
String
Experiment ID to search over.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username name status]. Dynamic search key words are supported for experiment runs. Supported fields are [metrics tags params].
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username name start_time]. It also supports dynamic sort for metrics, tags and params. "+" means sort by ascending order, and "-" means sort by descending order.

Responses

Status: 200 - A successful response.

{

List experiments runs response contains an array of experiment runs.

experiment_runs:
[

ExperimentRuns that match the search criteria.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location (relative to the experiment run's root artifact directory) and metadata for artifacts.

{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}
]
registered_model_metadata:
[

RegisteredModelMetadata is used to show what model version is registered for this model.

{

RegisteredModelMetadata is used to represent model version metadata.

model_path:
string

model_path artifact folder name.

model_name:
string

model_name.

model_id:
string

model_id of the registered model id.

model_version_id:
string

model_version_id of the.

version_number:
integer (int32)

count of the model version.

run_id:
string

run_id of the experiment run.

created_at:
string (date-time)

created_at timestamp of model registered.

}
]
}
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listExperiments

List all experiments in a given project.


/api/v2/projects/{project_id}/experiments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentsResponse result = apiInstance.listExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentsResponse result = apiInstance.listExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperiments");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all experiments in a given project.
[apiInstance listExperimentsWith:projectId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListExperimentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listExperiments(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listExperimentsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by. (optional) 

            try
            {
                // List all experiments in a given project.
                ListExperimentsResponse result = apiInstance.listExperiments(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.

try {
    $result = $api_instance->listExperiments($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listExperiments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.

eval { 
    my $result = $api_instance->listExperiments(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listExperiments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by. (optional)

try: 
    # List all experiments in a given project.
    api_response = api_instance.list_experiments(projectId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listExperiments: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by.

Responses

Status: 200 - A successful response.

ListExperimentsResponse containes array of experiment objects {
experiments:
[
{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listGroupsQuota

Return all the groups and its quotas based on the context. Admin gets all the groups details.


/api/v2/groupsquota

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/groupsquota?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListGroupsQuotaResponse result = apiInstance.listGroupsQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listGroupsQuota");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListGroupsQuotaResponse result = apiInstance.listGroupsQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listGroupsQuota");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return all the groups and its quotas based on the context. Admin gets all the groups details.
[apiInstance listGroupsQuotaWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListGroupsQuotaResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listGroupsQuota(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listGroupsQuotaExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // Return all the groups and its quotas based on the context. Admin gets all the groups details.
                ListGroupsQuotaResponse result = apiInstance.listGroupsQuota(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listGroupsQuota: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listGroupsQuota($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listGroupsQuota: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listGroupsQuota(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listGroupsQuota: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # Return all the groups and its quotas based on the context. Admin gets all the groups details.
    api_response = api_instance.list_groups_quota(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listGroupsQuota: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [banned deactivated]. For example: search_filter={"deactivated":"false","banned":"false"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [username]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=username.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{
group_quota:
list of user quotas[
{
group:
User or Group Info {
id:
id of the user or group integer (int64)
html_url:
html_url of the user or group string
url:
url of the user or group string
name:
name of the user or group string
user_name:
username of the user or group string
}
quota_usage:
{
cpu:
CPU quota string
memory:
Memory quota string
nvidia_gpu:
Nvidia GPU quota string
}
quota_configured:
{
cpu:
CPU quota string
memory:
Memory quota string
nvidia_gpu:
Nvidia GPU quota string
}
}
]
next_page_token:
string

Next page token.

total_count:
total count of groups quota string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listJobRuns

Lists job runs, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/jobs/{job_id}/runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job runs.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobRunsResponse result = apiInstance.listJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job runs.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobRunsResponse result = apiInstance.listJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobRuns");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // ID of the job containing the job runs.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Lists job runs, optionally filtered, sorted, and paginated.
[apiInstance listJobRunsWith:projectId
    jobId:jobId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobRunsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} ID of the job containing the job runs.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJobRuns(projectId, jobId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJobRunsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | ID of the job containing the job runs.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Lists job runs, optionally filtered, sorted, and paginated.
                ListJobRunsResponse result = apiInstance.listJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listJobRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | ID of the job containing the job runs.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listJobRuns($projectId, $jobId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listJobRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | ID of the job containing the job runs.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listJobRuns(projectId => $projectId, jobId => $jobId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listJobRuns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | ID of the job containing the job runs.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Lists job runs, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_job_runs(projectId, jobId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listJobRuns: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
ID of the job containing the job runs.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type], where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout] For example: search_filter={"status":"running","id": "1"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]" where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,+name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Zero or more job runs.

job_runs:
[

A list of job runs.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}
]
next_page_token:
string

A token for the next page of job runs.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listJobs

Returns all jobs, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobs");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Returns all jobs, optionally filtered, sorted, and paginated.
[apiInstance listJobsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJobs(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJobsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Returns all jobs, optionally filtered, sorted, and paginated.
                ListJobsResponse result = apiInstance.listJobs(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listJobs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listJobs($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listJobs(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project's identifier
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Returns all jobs, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_jobs(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listJobs: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type]. For example: search_filter={"name":"foo","creator.name":"bar"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at], where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=+name,-created_at.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of jobs.

jobs:
[

Jobs is the response object with details on a list of jobs.

{

One Job.

id:
string

Public identifier of the job. Output only.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created. Output only.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes. Output only.

english_schedule:
string

English schedule. Output only.

arguments:
string

Arguments to the job.

type:
string

Type of job, whether it's "manual", "cron", or "dependent" Output only.

kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused. Output only.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job if this is a scheduled job. Output only.

updated_at:
string (date-time)

When the job was last updated. Output only.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
string

The runtime image identifier if this is a runtime job. Will be blank if using engines.

runtime_addon_identifiers:
[

The runtime addons associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill this job when it times out.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listModelBuilds

List model builds, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models/{model_id}/builds

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get builds for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelBuildsResponse result = apiInstance.listModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelBuilds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get builds for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelBuildsResponse result = apiInstance.listModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelBuilds");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to get builds for.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List model builds, optionally filtered, sorted, and paginated.
[apiInstance listModelBuildsWith:projectId
    modelId:modelId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelBuildsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to get builds for.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModelBuilds(projectId, modelId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listModelBuildsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to get builds for.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List model builds, optionally filtered, sorted, and paginated.
                ListModelBuildsResponse result = apiInstance.listModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listModelBuilds: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to get builds for.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listModelBuilds($projectId, $modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listModelBuilds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to get builds for.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listModelBuilds(projectId => $projectId, modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listModelBuilds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to get builds for.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List model builds, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_model_builds(projectId, modelId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listModelBuilds: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to get builds for.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [comment creator.email creator.name creator.username crn status], where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown] For example: search_filter={"comment":"foo","status":"pending"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=creator.email.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{

Response for listing model builds.

model_builds:
[

The page of model builds.

{

A single model build.

id:
string

ID of the model build.

model_id:
string

ID of the model containing the build.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
comment:
string

The comment associated with the build.

file_path:
string

Path from the project root to the file to build.

function_name:
string

Name of the function to run.

engine_image:
string

The engine image to build the model with.

kernel:
string

The kernel to run the build with.

created_at:
string (date-time)

When the model build was created.

updated_at:
string (date-time)

When the model build was most recently updated.

status:
string

Status of the build.

deletion_status:
string

State of the deletion of the build.

crn:
string

CRN of the build.

built_at:
string (date-time)

When the model build was most recently updated.

runtime_identifier:
string

Runtime identifier if this model uses runtimes.

runtime_addon_identifiers:
[

Runtime addons if this model uses runtimes.

string
]
registered_model_version_id:
string

ID of the registered model version.

}
]
next_page_token:
string

The next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listModelDeployments

List model deployments, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get deployments for.
        String buildId = buildId_example; // String | ID of the model build to get deployments for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListModelDeploymentsResponse result = apiInstance.listModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelDeployments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get deployments for.
        String buildId = buildId_example; // String | ID of the model build to get deployments for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListModelDeploymentsResponse result = apiInstance.listModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelDeployments");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to get deployments for.
String *buildId = buildId_example; // ID of the model build to get deployments for.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List model deployments, optionally filtered, sorted, and paginated.
[apiInstance listModelDeploymentsWith:projectId
    modelId:modelId
    buildId:buildId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListModelDeploymentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to get deployments for.
var buildId = buildId_example; // {{String}} ID of the model build to get deployments for.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModelDeployments(projectId, modelId, buildId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listModelDeploymentsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to get deployments for.
            var buildId = buildId_example;  // String | ID of the model build to get deployments for.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional) 

            try
            {
                // List model deployments, optionally filtered, sorted, and paginated.
                ListModelDeploymentsResponse result = apiInstance.listModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listModelDeployments: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to get deployments for.
$buildId = buildId_example; // String | ID of the model build to get deployments for.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

try {
    $result = $api_instance->listModelDeployments($projectId, $modelId, $buildId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listModelDeployments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to get deployments for.
my $buildId = buildId_example; # String | ID of the model build to get deployments for.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

eval { 
    my $result = $api_instance->listModelDeployments(projectId => $projectId, modelId => $modelId, buildId => $buildId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listModelDeployments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to get deployments for.
buildId = buildId_example # String | ID of the model build to get deployments for.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

try: 
    # List model deployments, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_model_deployments(projectId, modelId, buildId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listModelDeployments: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to get deployments for.
Required
build_id*
String
ID of the model build to get deployments for.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: []. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=.

Responses

Status: 200 - A successful response.

{

Response for listing model deployments.

model_deployments:
[

The page of model deployments.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

replicas:
integer (int32)

Number of Replicas.

}
]
next_page_token:
string

The next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listModels

List models, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list models under.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelsResponse result = apiInstance.listModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list models under.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelsResponse result = apiInstance.listModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModels");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project to list models under.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List models, optionally filtered, sorted, and paginated.
[apiInstance listModelsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project to list models under.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModels(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project to list models under.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List models, optionally filtered, sorted, and paginated.
                ListModelsResponse result = apiInstance.listModels(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listModels: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project to list models under.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listModels($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project to list models under.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listModels(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project to list models under.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List models, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_models(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listModels: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project to list models under.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name]. For example: search_filter={"name":"foo","auth_enabled":"f"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=created_at.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{

Response for listing models.

models:
[

The models in this page.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
registered_model_id:
string

Registered Model ID reference to model Regisry.

visibility:
string

Visibility of the model.

default_resources:
Details of a model's default resources {
cpu_millicores:
New number of cpu millicores for the model string (int64)
memory_mb:
New number of memory (in MB) for the model string (int64)
nvidia_gpus:
New number of Nvidia GPUs for the model string (int64)
}
default_replication_policy:
Details of a model's default replication policy {
num_replicas:
Number of replicas to use for the model string (int64)
type:
Type of replication to use (i.e. fixed) string
}
run_as:
userID of the service account that should be used to create/deploy the model When it is empty, creator's userID is used integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}
]
next_page_token:
string

The page token for the next page.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listNewsFeeds

List the newsfeeds, optionally filtered, sorted, and paginated.


/api/v2/newsfeeds/{category}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/newsfeeds/{category}?page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String category = category_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListNewsFeedsResponse result = apiInstance.listNewsFeeds(category, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listNewsFeeds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String category = category_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListNewsFeedsResponse result = apiInstance.listNewsFeeds(category, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listNewsFeeds");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // 
Integer *pageSize = 56; //  (optional)
String *pageToken = pageToken_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List the newsfeeds, optionally filtered, sorted, and paginated.
[apiInstance listNewsFeedsWith:category
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListNewsFeedsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var category = category_example; // {{String}} 
var opts = { 
  'pageSize': 56, // {{Integer}} 
  'pageToken': pageToken_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listNewsFeeds(category, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listNewsFeedsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var category = category_example;  // String | 
            var pageSize = 56;  // Integer |  (optional) 
            var pageToken = pageToken_example;  // String |  (optional) 

            try
            {
                // List the newsfeeds, optionally filtered, sorted, and paginated.
                ListNewsFeedsResponse result = apiInstance.listNewsFeeds(category, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listNewsFeeds: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$category = category_example; // String | 
$pageSize = 56; // Integer | 
$pageToken = pageToken_example; // String | 

try {
    $result = $api_instance->listNewsFeeds($category, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listNewsFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $category = category_example; # String | 
my $pageSize = 56; # Integer | 
my $pageToken = pageToken_example; # String | 

eval { 
    my $result = $api_instance->listNewsFeeds(category => $category, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listNewsFeeds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
category = category_example # String | 
pageSize = 56 # Integer |  (optional)
pageToken = pageToken_example # String |  (optional)

try: 
    # List the newsfeeds, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_news_feeds(category, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listNewsFeeds: %s\n" % e)

Parameters

Path parameters
Name Description
category*
String
Required
Query parameters
Name Description
page_size
Integer (int32)
page_token
String

Responses

Status: 200 - A successful response.

{
feeds:
[
{
title:
string
description:
string
category:
string
tags:
[
string
]
link:
string
imgpath:
string
is_viewed:
boolean (boolean)
date:
string (date-time)

created at YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format).

icon:
string
is_new:
boolean (boolean)
description_html:
string
}
]
next_page_token:
string
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listProjectCollaborators

List project collaborators.


/api/v2/projects/{project_id}/collaborators

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/collaborators?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListProjectCollaboratorsResponse result = apiInstance.listProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectCollaborators");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListProjectCollaboratorsResponse result = apiInstance.listProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectCollaborators");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List project collaborators.
[apiInstance listProjectCollaboratorsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListProjectCollaboratorsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectCollaborators(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectCollaboratorsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List project collaborators.
                ListProjectCollaboratorsResponse result = apiInstance.listProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjectCollaborators: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listProjectCollaborators($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjectCollaborators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listProjectCollaborators(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjectCollaborators: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List project collaborators.
    api_response = api_instance.list_project_collaborators(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjectCollaborators: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [username, permission]. For example: search_filter={"username":"foo", "permission": "read"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [username, permission]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-username,+permission.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Response for getting project collaborators.

collaborators:
The collaborators of the project[
Abbreviated project collaborator information {
user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
permission:
string

Permission to the project.

}
]
next_page_token:
string

Next page token is a value that can be added to a new ListProjectCollaborators call to fetch the next page of projects, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listProjectFiles

List files/subdirectories at a specified path


/api/v2/projects/{project_id}/files/{path}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/files/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the files to list.
        String path = path_example; // String | Path to list, relative to project root (/home/cdsw)
        try {
            ListProjectFilesResponse result = apiInstance.listProjectFiles(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the files to list.
        String path = path_example; // String | Path to list, relative to project root (/home/cdsw)
        try {
            ListProjectFilesResponse result = apiInstance.listProjectFiles(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectFiles");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project that contains the files to list.
String *path = path_example; // Path to list, relative to project root (/home/cdsw)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List files/subdirectories at a specified path
[apiInstance listProjectFilesWith:projectId
    path:path
              completionHandler: ^(ListProjectFilesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project that contains the files to list.
var path = path_example; // {{String}} Path to list, relative to project root (/home/cdsw)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectFiles(projectId, path, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectFilesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project that contains the files to list.
            var path = path_example;  // String | Path to list, relative to project root (/home/cdsw)

            try
            {
                // List files/subdirectories at a specified path
                ListProjectFilesResponse result = apiInstance.listProjectFiles(projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjectFiles: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project that contains the files to list.
$path = path_example; // String | Path to list, relative to project root (/home/cdsw)

try {
    $result = $api_instance->listProjectFiles($projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjectFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project that contains the files to list.
my $path = path_example; # String | Path to list, relative to project root (/home/cdsw)

eval { 
    my $result = $api_instance->listProjectFiles(projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjectFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project that contains the files to list.
path = path_example # String | Path to list, relative to project root (/home/cdsw)

try: 
    # List files/subdirectories at a specified path
    api_response = api_instance.list_project_files(projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjectFiles: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project that contains the files to list.
Required
path*
String
Path to list, relative to project root (/home/cdsw)
Required

Responses

Status: 200 - A successful response.

{

Response object for listing project files.

files:
[

The files/directories in the provided path.

{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}
]
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listProjectNames

Return all the project names the user has access to, optionally filtered, sorted, and paginated.


/api/v2/projectnames

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projectnames?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListProjectNamesResponse result = apiInstance.listProjectNames(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectNames");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListProjectNamesResponse result = apiInstance.listProjectNames(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectNames");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return all the project names the user has access to, optionally filtered, sorted, and paginated.
[apiInstance listProjectNamesWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListProjectNamesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectNames(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectNamesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // Return all the project names the user has access to, optionally filtered, sorted, and paginated.
                ListProjectNamesResponse result = apiInstance.listProjectNames(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjectNames: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listProjectNames($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjectNames: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listProjectNames(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjectNames: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # Return all the project names the user has access to, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_project_names(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjectNames: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [name]. For example: search_filter={"name":"project name"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [name]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=name.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{
project_names:
list of project names[
string
]
next_page_token:
string

Next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listProjects

Return all projects, optionally filtered, sorted, and paginated.


/api/v2/projects

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects?search_filter=&sort=&page_size=&page_token=&include_public_projects=&include_all_projects="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        Boolean includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
        Boolean includeAllProjects = true; // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.
        try {
            ListProjectsResponse result = apiInstance.listProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        Boolean includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
        Boolean includeAllProjects = true; // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.
        try {
            ListProjectsResponse result = apiInstance.listProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjects");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
Boolean *includePublicProjects = true; // Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional)
Boolean *includeAllProjects = true; // Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return all projects, optionally filtered, sorted, and paginated.
[apiInstance listProjectsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    includePublicProjects:includePublicProjects
    includeAllProjects:includeAllProjects
              completionHandler: ^(ListProjectsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'includePublicProjects': true, // {{Boolean}} Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
  'includeAllProjects': true // {{Boolean}} Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjects(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var includePublicProjects = true;  // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional) 
            var includeAllProjects = true;  // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects. (optional) 

            try
            {
                // Return all projects, optionally filtered, sorted, and paginated.
                ListProjectsResponse result = apiInstance.listProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjects: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
$includeAllProjects = true; // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.

try {
    $result = $api_instance->listProjects($searchFilter, $sort, $pageSize, $pageToken, $includePublicProjects, $includeAllProjects);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $includePublicProjects = true; # Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
my $includeAllProjects = true; # Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.

eval { 
    my $result = $api_instance->listProjects(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, includePublicProjects => $includePublicProjects, includeAllProjects => $includeAllProjects);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
includePublicProjects = true # Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional)
includeAllProjects = true # Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects. (optional)

try: 
    # Return all projects, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_projects(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, includePublicProjects=includePublicProjects, includeAllProjects=includeAllProjects)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjects: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username]. For example: search_filter={"name":"foo","creator.name":"bar"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,+name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
include_public_projects
Boolean (boolean)
Default is false. If include_public_projects is set to true, then it will return all projects user has access to, including public projects.
include_all_projects
Boolean (boolean)
Default is false. If include_all_projects is set to true, then it will return all projects in the workspace if user is a site admin. If user is not a site admin, then it will be equivalent to making use of flag include_public_projects and will return all projects user has access to, including public projects.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of projects.

projects:
[

Projects is the response object with details on a list of projects.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

inherit:
boolean (boolean)

inherit is meant to be used only for teams.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}
]
next_page_token:
string

Next page token is a value that can be added to a new ListProjects call to fetch the next page of projects, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listRegisteredModels

List registered models.


/api/v2/registry/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/registry/models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListRegisteredModelsResponse result = apiInstance.listRegisteredModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRegisteredModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListRegisteredModelsResponse result = apiInstance.listRegisteredModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRegisteredModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List registered models.
[apiInstance listRegisteredModelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListRegisteredModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegisteredModels(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRegisteredModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List registered models.
                ListRegisteredModelsResponse result = apiInstance.listRegisteredModels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRegisteredModels: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listRegisteredModels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRegisteredModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listRegisteredModels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRegisteredModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List registered models.
    api_response = api_instance.list_registered_models(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRegisteredModels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search_filter = {"model_name": "model_name"} search_filter = {"creator_id": "<sso name or user name>"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-created_at.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

ListRegisteredModelsResponse returns a list of registered models.

models:
[

List of registered models.

{
model_id:
string

Model ID.

name:
string

Model name.

description:
string

Model description.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
permission:
string

Permission of the user requesting the model.

visibility:
string
Default: PRIVATE
Enum: PRIVATE, PUBLIC
created_at:
string (date-time)

Model creation time.

updated_at:
string (date-time)

Model last updated time.

count:
integer (int32)

Model version count.

next_page_token:
string

next_page_token is a token to get the next page of results.

}
]
next_page_token:
string

Next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listRuntimeAddons

List the available runtime addons, optionally filtered, sorted, and paginated.


/api/v2/runtimeaddons

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimeaddons?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListRuntimeAddonsResponse result = apiInstance.listRuntimeAddons(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeAddons");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListRuntimeAddonsResponse result = apiInstance.listRuntimeAddons(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeAddons");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List the available runtime addons, optionally filtered, sorted, and paginated.
[apiInstance listRuntimeAddonsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListRuntimeAddonsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRuntimeAddons(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRuntimeAddonsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by. (optional) 

            try
            {
                // List the available runtime addons, optionally filtered, sorted, and paginated.
                ListRuntimeAddonsResponse result = apiInstance.listRuntimeAddons(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRuntimeAddons: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.

try {
    $result = $api_instance->listRuntimeAddons($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRuntimeAddons: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.

eval { 
    my $result = $api_instance->listRuntimeAddons(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRuntimeAddons: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by. (optional)

try: 
    # List the available runtime addons, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_runtime_addons(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRuntimeAddons: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: ["identifier", "component", "display_name", "status"]. For example: search_filter = {"component": "Spark", "status": "AVAILABLE"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by.

Responses

Status: 200 - A successful response.

{

Response for listing runtime addons.

runtime_addons:
The page of runtime addons;[
{

A single runtime addon.

identifier:
string

The unique identifier of the runtime addon.

component:
string

The component this addon relates to, i.e. Spark.

display_name:
string

The display name of the addon.

status:
string

The addon's status.

manageable:
boolean (boolean)

Manageable addon.

created_at:
string (date-time)

When the deployment was created.

id:
integer (int32)

ID of the addon.

reason:
string

Reason of not availability.

}
]
next_page_token:
string

A token to fetch the next page of runtime addons.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listRuntimeRepos

List Runtime repos.


/api/v2/runtimerepos

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimerepos?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListRuntimeReposResponse result = apiInstance.listRuntimeRepos(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeRepos");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListRuntimeReposResponse result = apiInstance.listRuntimeRepos(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeRepos");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List Runtime repos.
[apiInstance listRuntimeReposWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListRuntimeReposResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRuntimeRepos(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRuntimeReposExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List Runtime repos.
                ListRuntimeReposResponse result = apiInstance.listRuntimeRepos(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRuntimeRepos: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listRuntimeRepos($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRuntimeRepos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listRuntimeRepos(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRuntimeRepos: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List Runtime repos.
    api_response = api_instance.list_runtime_repos(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRuntimeRepos: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [id name url]. For example: search_filter={"id":"1","name":"My Repo","url":"my.url"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [id name url]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=id.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{
runtimerepos:
list of RuntimeRepos[
{
id:
The numeric identifier for this runtime repo integer (int32)
name:
The name of this runtime repo string
url:
The URL of this runtime repo string
}
]
next_page_token:
string

Next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listRuntimes

List the available runtimes, optionally filtered, sorted, and paginated.


/api/v2/runtimes

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimes?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
        try {
            ListRuntimesResponse result = apiInstance.listRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
        try {
            ListRuntimesResponse result = apiInstance.listRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimes");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List the available runtimes, optionally filtered, sorted, and paginated.
[apiInstance listRuntimesWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListRuntimesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRuntimes(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRuntimesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional) 

            try
            {
                // List the available runtimes, optionally filtered, sorted, and paginated.
                ListRuntimesResponse result = apiInstance.listRuntimes(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRuntimes: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.

try {
    $result = $api_instance->listRuntimes($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRuntimes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.

eval { 
    my $result = $api_instance->listRuntimes(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRuntimes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional)

try: 
    # List the available runtimes, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_runtimes(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRuntimes: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"]. For example: search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-kernel,+editor.

Responses

Status: 200 - A successful response.

{

Response for listing runtimes.

runtimes:
[

The page of runtimes.

{

A single runtime.

image_identifier:
string

The identifier for this runtime.

editor:
string

The editor configured for this runtime.

kernel:
string

The kernel associated with this runtime.

edition:
string

The edition of this runtime.

description:
string

A short description of the runtime.

full_version:
string

The full version of the runtime.

status:
string

Status of the runtime.

register_user_id:
User ID of the user who registered the runtime integer (int32)
}
]
next_page_token:
string

A token to fetch the next page of runtimes.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listSyncedTeamGroups

List cdp groups with their default permission for a synced team


/api/v2/teams/{team_name}/groups

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/teams/{team_name}/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | team name
        try {
            ListSyncedTeamGroupsResponse result = apiInstance.listSyncedTeamGroups(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listSyncedTeamGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | team name
        try {
            ListSyncedTeamGroupsResponse result = apiInstance.listSyncedTeamGroups(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listSyncedTeamGroups");
            e.printStackTrace();
        }
    }
}
String *teamName = teamName_example; // team name

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List cdp groups with their default permission for a synced team
[apiInstance listSyncedTeamGroupsWith:teamName
              completionHandler: ^(ListSyncedTeamGroupsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var teamName = teamName_example; // {{String}} team name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSyncedTeamGroups(teamName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSyncedTeamGroupsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var teamName = teamName_example;  // String | team name

            try
            {
                // List cdp groups with their default permission for a synced team
                ListSyncedTeamGroupsResponse result = apiInstance.listSyncedTeamGroups(teamName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listSyncedTeamGroups: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$teamName = teamName_example; // String | team name

try {
    $result = $api_instance->listSyncedTeamGroups($teamName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listSyncedTeamGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $teamName = teamName_example; # String | team name

eval { 
    my $result = $api_instance->listSyncedTeamGroups(teamName => $teamName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listSyncedTeamGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
teamName = teamName_example # String | team name

try: 
    # List cdp groups with their default permission for a synced team
    api_response = api_instance.list_synced_team_groups(teamName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listSyncedTeamGroups: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
team name
Required

Responses

Status: 200 - A successful response.

{
groups:
[
{
cn:
string
dn:
string
id:
string (int64)
last_synced_at:
string (date-time)
permission:
string
team_id:
string (int64)
}
]
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listSyncedTeamMembers

List synced team members with cdp group info


/api/v2/teams/{team_name}/group_members

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/teams/{team_name}/group_members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | team name
        try {
            ListSyncedTeamMembersResponse result = apiInstance.listSyncedTeamMembers(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listSyncedTeamMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | team name
        try {
            ListSyncedTeamMembersResponse result = apiInstance.listSyncedTeamMembers(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listSyncedTeamMembers");
            e.printStackTrace();
        }
    }
}
String *teamName = teamName_example; // team name

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List synced team members with cdp group info
[apiInstance listSyncedTeamMembersWith:teamName
              completionHandler: ^(ListSyncedTeamMembersResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var teamName = teamName_example; // {{String}} team name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSyncedTeamMembers(teamName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSyncedTeamMembersExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var teamName = teamName_example;  // String | team name

            try
            {
                // List synced team members with cdp group info
                ListSyncedTeamMembersResponse result = apiInstance.listSyncedTeamMembers(teamName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listSyncedTeamMembers: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$teamName = teamName_example; // String | team name

try {
    $result = $api_instance->listSyncedTeamMembers($teamName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listSyncedTeamMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $teamName = teamName_example; # String | team name

eval { 
    my $result = $api_instance->listSyncedTeamMembers(teamName => $teamName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listSyncedTeamMembers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
teamName = teamName_example # String | team name

try: 
    # List synced team members with cdp group info
    api_response = api_instance.list_synced_team_members(teamName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listSyncedTeamMembers: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
team name
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listUsage

Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.


/api/v2/usage

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/usage?search_filter=&sort=&page_size=&page_token=&multi_column_search_filter=&time_range_search_filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        try {
            ListUsageResponse result = apiInstance.listUsage(searchFilter, sort, pageSize, pageToken, multiColumnSearchFilter, timeRangeSearchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        try {
            ListUsageResponse result = apiInstance.listUsage(searchFilter, sort, pageSize, pageToken, multiColumnSearchFilter, timeRangeSearchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listUsage");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *multiColumnSearchFilter = multiColumnSearchFilter_example; // Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
String *timeRangeSearchFilter = timeRangeSearchFilter_example; // Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.
[apiInstance listUsageWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    multiColumnSearchFilter:multiColumnSearchFilter
    timeRangeSearchFilter:timeRangeSearchFilter
              completionHandler: ^(ListUsageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'multiColumnSearchFilter': multiColumnSearchFilter_example, // {{String}} Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
  'timeRangeSearchFilter': timeRangeSearchFilter_example // {{String}} Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsage(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listUsageExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var multiColumnSearchFilter = multiColumnSearchFilter_example;  // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional) 
            var timeRangeSearchFilter = timeRangeSearchFilter_example;  // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional) 

            try
            {
                // Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.
                ListUsageResponse result = apiInstance.listUsage(searchFilter, sort, pageSize, pageToken, multiColumnSearchFilter, timeRangeSearchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listUsage: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
$timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.

try {
    $result = $api_instance->listUsage($searchFilter, $sort, $pageSize, $pageToken, $multiColumnSearchFilter, $timeRangeSearchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listUsage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $multiColumnSearchFilter = multiColumnSearchFilter_example; # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
my $timeRangeSearchFilter = timeRangeSearchFilter_example; # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.

eval { 
    my $result = $api_instance->listUsage(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, multiColumnSearchFilter => $multiColumnSearchFilter, timeRangeSearchFilter => $timeRangeSearchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listUsage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
multiColumnSearchFilter = multiColumnSearchFilter_example # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
timeRangeSearchFilter = timeRangeSearchFilter_example # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)

try: 
    # Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_usage(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, multiColumnSearchFilter=multiColumnSearchFilter, timeRangeSearchFilter=timeRangeSearchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listUsage: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [name creator group project_name workload_type status]. For example: search_filter={"name":"My Session","workload_type":"session"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=name.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.
multi_column_search_filter
String
Multi column search filter is an optional HTTP parameter to filter multiple columns. Supported Multi column search filter keys are: [project_or_workload_name]. For example: multi_column_search_filter={"project_or_workload_name":"name"}.
time_range_search_filter
String
Time range search filter is an optional HTTP parameter to filter based on the time. Supported Time range search filters are: [created_time]. For example: time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.

Responses

Status: 200 - A successful response.

Response object for usage view {
usage_response:
list of usage response[
Response object for each usage {
name:
Name of the workload string
creator:
The creator details string
group:
The name of the group in which the workload runs string
project_name:
The project name string
cpu:
The cpu used by the worklod number (float)
memory:
The memory used by the worklod number (float)
nvidia_gpu:
The nvidia_gpu used by the worklod number (float)
workload_type:
The workload type string
created_at:
The created time stamp string (date-time)
duration:
The durtaion of the worklod string (int64)
status:
The workload status string
creator_info:
User or Group Info {
id:
id of the user or group integer (int64)
html_url:
html_url of the user or group string
url:
url of the user or group string
name:
name of the user or group string
user_name:
username of the user or group string
}
group_info:
User or Group Info {
id:
id of the user or group integer (int64)
html_url:
html_url of the user or group string
url:
url of the user or group string
name:
name of the user or group string
user_name:
username of the user or group string
}
project_info:
Project information {
id:
project id integer (int64)
slug:
project slug string
html_url:
html_url of the project string
url:
url of the project string
}
id:
The id of the usage response string
workload_url:
The workload html_url string
message:
The message string
oom_killed:
OOM killed boolean (boolean)
k8s_info:
Kubernetes Info {
k8s_exit_code:
kubernetes exit code integer (int32)
k8s_signal:
kubernetes signal string
k8s_reason:
kubernetes reason string
k8s_message:
kubernetes message string
}
}
]
total_count:
total number of responses satisfying the request filter conditions string (int64)
next_page_token:
string

Next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listUsersAcceleratorQuota

Return all the quota usage for the user and accelerator based on the context. Admin gets all the users details.


/api/v2/userslabels/quota

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/userslabels/quota?search_filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}.
        try {
            ListUsersAcceleratorQuotaResponse result = apiInstance.listUsersAcceleratorQuota(searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listUsersAcceleratorQuota");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}.
        try {
            ListUsersAcceleratorQuotaResponse result = apiInstance.listUsersAcceleratorQuota(searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listUsersAcceleratorQuota");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return all the quota usage for the user and accelerator based on the context. Admin gets all the users details.
[apiInstance listUsersAcceleratorQuotaWith:searchFilter
              completionHandler: ^(ListUsersAcceleratorQuotaResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsersAcceleratorQuota(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listUsersAcceleratorQuotaExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}. (optional) 

            try
            {
                // Return all the quota usage for the user and accelerator based on the context. Admin gets all the users details.
                ListUsersAcceleratorQuotaResponse result = apiInstance.listUsersAcceleratorQuota(searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listUsersAcceleratorQuota: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}.

try {
    $result = $api_instance->listUsersAcceleratorQuota($searchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listUsersAcceleratorQuota: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}.

eval { 
    my $result = $api_instance->listUsersAcceleratorQuota(searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listUsersAcceleratorQuota: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [user_id accelerator_id]
For example:
search_filter={"user_id":"1","accelerator_id":"1"}. (optional)

try: 
    # Return all the quota usage for the user and accelerator based on the context. Admin gets all the users details.
    api_response = api_instance.list_users_accelerator_quota(searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listUsersAcceleratorQuota: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [user_id accelerator_id] For example: search_filter={"user_id":"1","accelerator_id":"1"}.

Responses

Status: 200 - A successful response.

{
user_accelerator_quota:
list of user quotas[
{
user_id:
userid of user string
username:
username of user string
accelerator_id:
accelerator id string
quota_usage:
{
cpu:
CPU quota string
memory:
Memory quota string
nvidia_gpu:
Nvidia GPU quota string
}
quota_configured:
{
cpu:
CPU quota string
memory:
Memory quota string
nvidia_gpu:
Nvidia GPU quota string
}
}
]
next_page_token:
string

Next page token.

total_count:
total count of users quota string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listUsersQuota

Return all the user names and quotas based on the context. Admin gets all the users details.


/api/v2/usersquota

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/usersquota?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListUsersQuotaResponse result = apiInstance.listUsersQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listUsersQuota");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListUsersQuotaResponse result = apiInstance.listUsersQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listUsersQuota");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return all the user names and quotas based on the context. Admin gets all the users details.
[apiInstance listUsersQuotaWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListUsersQuotaResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsersQuota(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listUsersQuotaExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // Return all the user names and quotas based on the context. Admin gets all the users details.
                ListUsersQuotaResponse result = apiInstance.listUsersQuota(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listUsersQuota: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listUsersQuota($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listUsersQuota: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listUsersQuota(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listUsersQuota: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # Return all the user names and quotas based on the context. Admin gets all the users details.
    api_response = api_instance.list_users_quota(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listUsersQuota: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [banned deactivated]. For example: search_filter={"deactivated":"false","banned":"false"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [username]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=username.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{
user_quota:
list of user quotas[
{
user:
User or Group Info {
id:
id of the user or group integer (int64)
html_url:
html_url of the user or group string
url:
url of the user or group string
name:
name of the user or group string
user_name:
username of the user or group string
}
quota_usage:
{
cpu:
CPU quota string
memory:
Memory quota string
nvidia_gpu:
Nvidia GPU quota string
}
quota_configured:
{
cpu:
CPU quota string
memory:
Memory quota string
nvidia_gpu:
Nvidia GPU quota string
}
}
]
next_page_token:
string

Next page token.

total_count:
total count of users quota string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listV2Keys

Get all API V2 keys


/api/v2/users/{username}/v2_keys

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/users/{username}/v2_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to get
        try {
            ListV2KeysResponse result = apiInstance.listV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listV2Keys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to get
        try {
            ListV2KeysResponse result = apiInstance.listV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listV2Keys");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // username of the user whose V2 keys you want to get

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get all API V2 keys
[apiInstance listV2KeysWith:username
              completionHandler: ^(ListV2KeysResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var username = username_example; // {{String}} username of the user whose V2 keys you want to get

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listV2Keys(username, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listV2KeysExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var username = username_example;  // String | username of the user whose V2 keys you want to get

            try
            {
                // Get all API V2 keys
                ListV2KeysResponse result = apiInstance.listV2Keys(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listV2Keys: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$username = username_example; // String | username of the user whose V2 keys you want to get

try {
    $result = $api_instance->listV2Keys($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listV2Keys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $username = username_example; # String | username of the user whose V2 keys you want to get

eval { 
    my $result = $api_instance->listV2Keys(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listV2Keys: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
username = username_example # String | username of the user whose V2 keys you want to get

try: 
    # Get all API V2 keys
    api_response = api_instance.list_v2_keys(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listV2Keys: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 keys you want to get
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listWorkloadExecutions

List all workloads and executions


/api/v2/workloads/executions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/workloads/executions?search_filter=&page_size=&page_token=&sort=&multi_column_search_filter=&time_range_search_filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}.
        try {
            ListWorkloadExecutionsResponse result = apiInstance.listWorkloadExecutions(searchFilter, pageSize, pageToken, sort, multiColumnSearchFilter, timeRangeSearchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listWorkloadExecutions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}.
        try {
            ListWorkloadExecutionsResponse result = apiInstance.listWorkloadExecutions(searchFilter, pageSize, pageToken, sort, multiColumnSearchFilter, timeRangeSearchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listWorkloadExecutions");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status. (optional)
String *multiColumnSearchFilter = multiColumnSearchFilter_example; // Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}. (optional)
String *timeRangeSearchFilter = timeRangeSearchFilter_example; // Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all workloads and executions
[apiInstance listWorkloadExecutionsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
    multiColumnSearchFilter:multiColumnSearchFilter
    timeRangeSearchFilter:timeRangeSearchFilter
              completionHandler: ^(ListWorkloadExecutionsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status.
  'multiColumnSearchFilter': multiColumnSearchFilter_example, // {{String}} Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}.
  'timeRangeSearchFilter': timeRangeSearchFilter_example // {{String}} Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listWorkloadExecutions(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listWorkloadExecutionsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status. (optional) 
            var multiColumnSearchFilter = multiColumnSearchFilter_example;  // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}. (optional) 
            var timeRangeSearchFilter = timeRangeSearchFilter_example;  // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}. (optional) 

            try
            {
                // List all workloads and executions
                ListWorkloadExecutionsResponse result = apiInstance.listWorkloadExecutions(searchFilter, pageSize, pageToken, sort, multiColumnSearchFilter, timeRangeSearchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listWorkloadExecutions: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status.
$multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}.
$timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}.

try {
    $result = $api_instance->listWorkloadExecutions($searchFilter, $pageSize, $pageToken, $sort, $multiColumnSearchFilter, $timeRangeSearchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listWorkloadExecutions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status.
my $multiColumnSearchFilter = multiColumnSearchFilter_example; # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}.
my $timeRangeSearchFilter = timeRangeSearchFilter_example; # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}.

eval { 
    my $result = $api_instance->listWorkloadExecutions(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort, multiColumnSearchFilter => $multiColumnSearchFilter, timeRangeSearchFilter => $timeRangeSearchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listWorkloadExecutions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [status].
For example:
  search_filter={"status":"running"}. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [start_time end_time status].
  sort=status. (optional)
multiColumnSearchFilter = multiColumnSearchFilter_example # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [workload_crn].
For example:
  multi_column_search_filter={"workload_crn":"id"}. (optional)
timeRangeSearchFilter = timeRangeSearchFilter_example # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [start_time, end_time].
For example:
  time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}. (optional)

try: 
    # List all workloads and executions
    api_response = api_instance.list_workload_executions(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort, multiColumnSearchFilter=multiColumnSearchFilter, timeRangeSearchFilter=timeRangeSearchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listWorkloadExecutions: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [status]. For example: search_filter={"status":"running"}.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [start_time end_time status]. sort=status.
multi_column_search_filter
String
Multi column search filter is an optional HTTP parameter to filter multiple columns. Supported Multi column search filter keys are: [workload_crn]. For example: multi_column_search_filter={"workload_crn":"id"}.
time_range_search_filter
String
Time range search filter is an optional HTTP parameter to filter based on the time. Supported Time range search filters are: [start_time, end_time]. For example: time_range_search_filter={"start_time":{"min":"2024-04-11T21:55:28.573Z","max":"2024-04-13T21:55:28.573Z"}}.

Responses

Status: 200 - A successful response.

{
workloads:
List of workloads[
Workload details {
workload_crn:
The CRN of the workload string
workload_name:
The name of the workload string
workload_type:
The type of workload (session, job, application, model) string
create_time:
Unix timestamp of when the workload was created string (date-time)
creator_user_crn:
The crn of the user that created the workload string
creator_user_name:
The username of the user that created the workload string
project:
A workload's project details {
id:
The ID of the project integer (int64)
crn:
The CRN of the project string
name:
The name of the project string
created_by_crn:
The CRN of the user that created the project string
created_by_name:
The username of user that created the project string
owner:
A workload's project's owner's details {
id:
The ID of the owner integer (int64)
crn:
The CRN of the owner string
name:
The username of the owner string
is_team:
If the owner is a team or not boolean (boolean)
}
}
deleted:
If the workload was deleted boolean (boolean)
}
]
executions:
List of executions for all workloads[
Workload execution details {
workload_crn:
The CRN of the workload string
workload_execution_crn:
The CRN of the execution string
parent_workload_execution_crn:
The CRN of the parent workload execution string
pod_name:
The name of the pod of the execution string
start_time:
Unix timestamp of when the execution started string (date-time)
end_time:
Unix timestamp of when the execution ended string (date-time)
allocated_cpu_cores:
The number of vCPU allocated for the execution (in cores) number (float)
allocated_memory_gb:
The memory allocated for the execution (in GB) number (float)
allocated_gpu_cores:
The number of Nvidia GPUs allocated for the execution number (float)
status:
The execution's status string
failure_reason:
The failure reason for the execution, if it exists string
run_as_user_crn:
The crn of the user that executed the execution string
run_as_user_name:
The username of the user that executed the execution string
runtime:
Details about an execution's runtime {
description:
string

A short description of the runtime.

editor:
string

The editor configured for this runtime.

edition:
string

The edition of this runtime.

kernel:
string

The kernel associated with this runtime.

full_version:
string

The full version of the runtime.

}
spark_event_log_dir:
The spark event log dir path for spark executors string
}
]
next_page_token:
string

A token to fetch the next page of workloads and executions.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listWorkloadStatus

Return the workload statuses.


/api/v2/workloadstatus

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/workloadstatus"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        try {
            ListWorkloadStatusResponse result = apiInstance.listWorkloadStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listWorkloadStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        try {
            ListWorkloadStatusResponse result = apiInstance.listWorkloadStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listWorkloadStatus");
            e.printStackTrace();
        }
    }
}

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return the workload statuses.
[apiInstance listWorkloadStatusWithCompletionHandler: 
              ^(ListWorkloadStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listWorkloadStatus(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listWorkloadStatusExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();

            try
            {
                // Return the workload statuses.
                ListWorkloadStatusResponse result = apiInstance.listWorkloadStatus();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listWorkloadStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();

try {
    $result = $api_instance->listWorkloadStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listWorkloadStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();

eval { 
    my $result = $api_instance->listWorkloadStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listWorkloadStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()

try: 
    # Return the workload statuses.
    api_response = api_instance.list_workload_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listWorkloadStatus: %s\n" % e)

Parameters

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

listWorkloadTypes

Return the workload types.


/api/v2/workloadtypes

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/workloadtypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        try {
            ListWorkloadTypesResponse result = apiInstance.listWorkloadTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listWorkloadTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        try {
            ListWorkloadTypesResponse result = apiInstance.listWorkloadTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listWorkloadTypes");
            e.printStackTrace();
        }
    }
}

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return the workload types.
[apiInstance listWorkloadTypesWithCompletionHandler: 
              ^(ListWorkloadTypesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listWorkloadTypes(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listWorkloadTypesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();

            try
            {
                // Return the workload types.
                ListWorkloadTypesResponse result = apiInstance.listWorkloadTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listWorkloadTypes: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();

try {
    $result = $api_instance->listWorkloadTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listWorkloadTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();

eval { 
    my $result = $api_instance->listWorkloadTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listWorkloadTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()

try: 
    # Return the workload types.
    api_response = api_instance.list_workload_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listWorkloadTypes: %s\n" % e)

Parameters

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

logExperimentRunBatch

Bulk update an experiment run details like metrics, params, tags in one request.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:logbatch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:logbatch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        LogExperimentRunBatchRequest body = ; // LogExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            LogExperimentRunBatchResponse result = apiInstance.logExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#logExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        LogExperimentRunBatchRequest body = ; // LogExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            LogExperimentRunBatchResponse result = apiInstance.logExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#logExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
LogExperimentRunBatchRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 
String *runId = runId_example; // ID of the ExperimentRun to log under

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Bulk update an experiment run details like metrics, params, tags in one request.
[apiInstance logExperimentRunBatchWith:body
    projectId:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(LogExperimentRunBatchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{LogExperimentRunBatchRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 
var runId = runId_example; // {{String}} ID of the ExperimentRun to log under

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logExperimentRunBatch(bodyprojectIdexperimentIdrunId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class logExperimentRunBatchExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new LogExperimentRunBatchRequest(); // LogExperimentRunBatchRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 
            var runId = runId_example;  // String | ID of the ExperimentRun to log under

            try
            {
                // Bulk update an experiment run details like metrics, params, tags in one request.
                LogExperimentRunBatchResponse result = apiInstance.logExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.logExperimentRunBatch: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // LogExperimentRunBatchRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 
$runId = runId_example; // String | ID of the ExperimentRun to log under

try {
    $result = $api_instance->logExperimentRunBatch($body, $projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->logExperimentRunBatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::LogExperimentRunBatchRequest->new(); # LogExperimentRunBatchRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 
my $runId = runId_example; # String | ID of the ExperimentRun to log under

eval { 
    my $result = $api_instance->logExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->logExperimentRunBatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # LogExperimentRunBatchRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 
runId = runId_example # String | ID of the ExperimentRun to log under

try: 
    # Bulk update an experiment run details like metrics, params, tags in one request.
    api_response = api_instance.log_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->logExperimentRunBatch: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required
run_id*
String
ID of the ExperimentRun to log under
Required
Body parameters
Name Description
body *
{

LogExperimentRunBatchRequest is used to bulk update ExperimentRun details like metrics, params, and tags in one request.

project_id:
string
experiment_id:
string
run_id:
ID of the ExperimentRun to log under string
metrics:
[

Metrics to log.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

Params to log.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Tags to log.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
model_json:
string

MLmodel file in json format.

}

Responses

Status: 200 - A successful response.

{

Response object to log an experiment batch.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

registerCustomRuntime

Register a runtime, given the URL to the image in the docker registry


/api/v2/runtimes

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        RegisterCustomRuntimeRequest body = ; // RegisterCustomRuntimeRequest | 
        try {
            RegisterCustomRuntimeResponse result = apiInstance.registerCustomRuntime(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#registerCustomRuntime");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        RegisterCustomRuntimeRequest body = ; // RegisterCustomRuntimeRequest | 
        try {
            RegisterCustomRuntimeResponse result = apiInstance.registerCustomRuntime(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#registerCustomRuntime");
            e.printStackTrace();
        }
    }
}
RegisterCustomRuntimeRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Register a runtime, given the URL to the image in the docker registry
[apiInstance registerCustomRuntimeWith:body
              completionHandler: ^(RegisterCustomRuntimeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{RegisterCustomRuntimeRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerCustomRuntime(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerCustomRuntimeExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new RegisterCustomRuntimeRequest(); // RegisterCustomRuntimeRequest | 

            try
            {
                // Register a runtime, given the URL to the image in the docker registry
                RegisterCustomRuntimeResponse result = apiInstance.registerCustomRuntime(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.registerCustomRuntime: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // RegisterCustomRuntimeRequest | 

try {
    $result = $api_instance->registerCustomRuntime($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->registerCustomRuntime: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::RegisterCustomRuntimeRequest->new(); # RegisterCustomRuntimeRequest | 

eval { 
    my $result = $api_instance->registerCustomRuntime(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->registerCustomRuntime: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # RegisterCustomRuntimeRequest | 

try: 
    # Register a runtime, given the URL to the image in the docker registry
    api_response = api_instance.register_custom_runtime(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->registerCustomRuntime: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
url:
string
docker_credential_id:
string
}

Responses

Status: 200 - A successful response.

{
validation_success:
boolean (boolean)
insert_success:
boolean (boolean)
reason:
string
reason_data:
string
details:
{
registry:
string
editor:
string
kernel:
string
edition:
string
version:
string
maintenance_version:
integer (int32)
description:
string
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

removeGroupFromSyncedTeam

Remove a cdp group from a synced team


/api/v2/teams/{team_name}/groups/{group_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/teams/{team_name}/groups/{group_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | team name
        String groupId = groupId_example; // String | group id
        try {
            RemoveGroupFromSyncedTeamResponse result = apiInstance.removeGroupFromSyncedTeam(teamName, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#removeGroupFromSyncedTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | team name
        String groupId = groupId_example; // String | group id
        try {
            RemoveGroupFromSyncedTeamResponse result = apiInstance.removeGroupFromSyncedTeam(teamName, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#removeGroupFromSyncedTeam");
            e.printStackTrace();
        }
    }
}
String *teamName = teamName_example; // team name
String *groupId = groupId_example; // group id

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Remove a cdp group from a synced team
[apiInstance removeGroupFromSyncedTeamWith:teamName
    groupId:groupId
              completionHandler: ^(RemoveGroupFromSyncedTeamResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var teamName = teamName_example; // {{String}} team name
var groupId = groupId_example; // {{String}} group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeGroupFromSyncedTeam(teamName, groupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeGroupFromSyncedTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var teamName = teamName_example;  // String | team name
            var groupId = groupId_example;  // String | group id

            try
            {
                // Remove a cdp group from a synced team
                RemoveGroupFromSyncedTeamResponse result = apiInstance.removeGroupFromSyncedTeam(teamName, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.removeGroupFromSyncedTeam: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$teamName = teamName_example; // String | team name
$groupId = groupId_example; // String | group id

try {
    $result = $api_instance->removeGroupFromSyncedTeam($teamName, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->removeGroupFromSyncedTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $teamName = teamName_example; # String | team name
my $groupId = groupId_example; # String | group id

eval { 
    my $result = $api_instance->removeGroupFromSyncedTeam(teamName => $teamName, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->removeGroupFromSyncedTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
teamName = teamName_example # String | team name
groupId = groupId_example # String | group id

try: 
    # Remove a cdp group from a synced team
    api_response = api_instance.remove_group_from_synced_team(teamName, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->removeGroupFromSyncedTeam: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
team name
Required
group_id*
String (int64)
group id
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

restartApplication

Start an application.


/api/v2/projects/{project_id}/applications/{application_id}:restart

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}:restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.restartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.restartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Start an application.
[apiInstance restartApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restartApplication(projectId, applicationId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restartApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Start an application.
                Application result = apiInstance.restartApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.restartApplication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->restartApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->restartApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->restartApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->restartApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Start an application.
    api_response = api_instance.restart_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->restartApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

restartModelDeployment

Restart a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:restart

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to restart.
        try {
            ModelDeployment result = apiInstance.restartModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to restart.
        try {
            ModelDeployment result = apiInstance.restartModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the deployment to restart.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Restart a model deployment.
[apiInstance restartModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the deployment to restart.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restartModelDeployment(projectId, modelId, buildId, deploymentId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restartModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the deployment to restart.

            try
            {
                // Restart a model deployment.
                ModelDeployment result = apiInstance.restartModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.restartModelDeployment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the deployment to restart.

try {
    $result = $api_instance->restartModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->restartModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the deployment to restart.

eval { 
    my $result = $api_instance->restartModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->restartModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the build containing the deployment.
deploymentId = deploymentId_example # String | ID of the deployment to restart.

try: 
    # Restart a model deployment.
    api_response = api_instance.restart_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->restartModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the build containing the deployment.
Required
deployment_id*
String
ID of the deployment to restart.
Required

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

replicas:
integer (int32)

Number of Replicas.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

rotateV1Key

Rotate API V1 key


/api/v2/users/{username}/v1_key:rotate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/users/{username}/v1_key:rotate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        RotateV1KeyRequest body = ; // RotateV1KeyRequest | 
        String username = username_example; // String | username of the user whose V1 key you want to rotate
        try {
            RotateV1KeyResponse result = apiInstance.rotateV1Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#rotateV1Key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        RotateV1KeyRequest body = ; // RotateV1KeyRequest | 
        String username = username_example; // String | username of the user whose V1 key you want to rotate
        try {
            RotateV1KeyResponse result = apiInstance.rotateV1Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#rotateV1Key");
            e.printStackTrace();
        }
    }
}
RotateV1KeyRequest *body = ; // 
String *username = username_example; // username of the user whose V1 key you want to rotate

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Rotate API V1 key
[apiInstance rotateV1KeyWith:body
    username:username
              completionHandler: ^(RotateV1KeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{RotateV1KeyRequest}} 
var username = username_example; // {{String}} username of the user whose V1 key you want to rotate

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rotateV1Key(bodyusername, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rotateV1KeyExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new RotateV1KeyRequest(); // RotateV1KeyRequest | 
            var username = username_example;  // String | username of the user whose V1 key you want to rotate

            try
            {
                // Rotate API V1 key
                RotateV1KeyResponse result = apiInstance.rotateV1Key(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.rotateV1Key: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // RotateV1KeyRequest | 
$username = username_example; // String | username of the user whose V1 key you want to rotate

try {
    $result = $api_instance->rotateV1Key($body, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->rotateV1Key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::RotateV1KeyRequest->new(); # RotateV1KeyRequest | 
my $username = username_example; # String | username of the user whose V1 key you want to rotate

eval { 
    my $result = $api_instance->rotateV1Key(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->rotateV1Key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # RotateV1KeyRequest | 
username = username_example # String | username of the user whose V1 key you want to rotate

try: 
    # Rotate API V1 key
    api_response = api_instance.rotate_v1_key(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->rotateV1Key: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V1 key you want to rotate
Required
Body parameters
Name Description
body *
{
username:
username of the user whose V1 key you want to rotate string
api_key_expiry_date:
api_key_expiry_date - optional string
api_key_comments:
api_key_comments - optional string
}

Responses

Status: 200 - A successful response.

{
api_key:
New api_key string
api_key_hash:
New api_key_hash string
api_key_expiry_date:
New api_key_expiry_date string
api_key_comments:
New api_key_comments string
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

sendCopilotEvent

Send a Copilot event.


/api/v2/copilot/event

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/event"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        SendCopilotEventRequest body = ; // SendCopilotEventRequest | 
        try {
            SendCopilotEventResponse result = apiInstance.sendCopilotEvent(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#sendCopilotEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        SendCopilotEventRequest body = ; // SendCopilotEventRequest | 
        try {
            SendCopilotEventResponse result = apiInstance.sendCopilotEvent(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#sendCopilotEvent");
            e.printStackTrace();
        }
    }
}
SendCopilotEventRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Send a Copilot event.
[apiInstance sendCopilotEventWith:body
              completionHandler: ^(SendCopilotEventResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{SendCopilotEventRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendCopilotEvent(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sendCopilotEventExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new SendCopilotEventRequest(); // SendCopilotEventRequest | 

            try
            {
                // Send a Copilot event.
                SendCopilotEventResponse result = apiInstance.sendCopilotEvent(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.sendCopilotEvent: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // SendCopilotEventRequest | 

try {
    $result = $api_instance->sendCopilotEvent($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->sendCopilotEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::SendCopilotEventRequest->new(); # SendCopilotEventRequest | 

eval { 
    my $result = $api_instance->sendCopilotEvent(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->sendCopilotEvent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # SendCopilotEventRequest | 

try: 
    # Send a Copilot event.
    api_response = api_instance.send_copilot_event(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->sendCopilotEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to record a Copilot event.

engine_id:
string

The ID of the engine.

application_id:
integer (int64)

The ID of the Copilot Application.

event_type:
One of: ["chat command", "slash command", "magic command", "model selection", "insert code", "replace code"] string
event_details:
Details associated with an event. For slash commands, this contains the actual command. E.g. "/fix" string
model_provider_id:
The provider ID string associated with a model. For GA, one of ["bedrock", "bedrock-chat", "cloudera"] string
model_name:
string

The name of the model.

model_type:
For GA, one of ["language", "embeddings"] string
include_selection:
boolean (boolean)

For slash or chat commands, indicates whether or not the user chose to include the highlighted code in the notebook as part of the prompt.

prompt_word_count:
integer (int64)

For slash and magic commands, a word count of the length of the prompt.

}

Responses

Status: 200 - A successful response.

{

The response from sending a Copilot event.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

setDockerCredential

Set a Docker credential for a Runtime.


/api/v2/runtimes/credential:set

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimes/credential:set"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        SetDockerCredentialRequest body = ; // SetDockerCredentialRequest | 
        try {
            SetDockerCredentialResponse result = apiInstance.setDockerCredential(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#setDockerCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        SetDockerCredentialRequest body = ; // SetDockerCredentialRequest | 
        try {
            SetDockerCredentialResponse result = apiInstance.setDockerCredential(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#setDockerCredential");
            e.printStackTrace();
        }
    }
}
SetDockerCredentialRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Set a Docker credential for a Runtime.
[apiInstance setDockerCredentialWith:body
              completionHandler: ^(SetDockerCredentialResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{SetDockerCredentialRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setDockerCredential(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setDockerCredentialExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new SetDockerCredentialRequest(); // SetDockerCredentialRequest | 

            try
            {
                // Set a Docker credential for a Runtime.
                SetDockerCredentialResponse result = apiInstance.setDockerCredential(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.setDockerCredential: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // SetDockerCredentialRequest | 

try {
    $result = $api_instance->setDockerCredential($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->setDockerCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::SetDockerCredentialRequest->new(); # SetDockerCredentialRequest | 

eval { 
    my $result = $api_instance->setDockerCredential(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->setDockerCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # SetDockerCredentialRequest | 

try: 
    # Set a Docker credential for a Runtime.
    api_response = api_instance.set_docker_credential(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->setDockerCredential: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
docker_credential_id:
string
runtime_identifier:
string
}

Responses

Status: 200 - A successful response.

{
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

stopApplication

Stop an application.


/api/v2/projects/{project_id}/applications/{application_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.stopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.stopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Stop an application.
[apiInstance stopApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopApplication(projectId, applicationId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Stop an application.
                Application result = apiInstance.stopApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.stopApplication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->stopApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->stopApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->stopApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->stopApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Stop an application.
    api_response = api_instance.stop_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->stopApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

stopJobRun

Stops a job run. Encoded as a custom method.


/api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to delete.
        try {
            JobRun result = apiInstance.stopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to delete.
        try {
            JobRun result = apiInstance.stopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopJobRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job
String *jobId = jobId_example; // ID of the job containing the job run.
String *runId = runId_example; // ID of the job run to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Stops a job run. Encoded as a custom method.
[apiInstance stopJobRunWith:projectId
    jobId:jobId
    runId:runId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job
var jobId = jobId_example; // {{String}} ID of the job containing the job run.
var runId = runId_example; // {{String}} ID of the job run to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopJobRun(projectId, jobId, runId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopJobRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job
            var jobId = jobId_example;  // String | ID of the job containing the job run.
            var runId = runId_example;  // String | ID of the job run to delete.

            try
            {
                // Stops a job run. Encoded as a custom method.
                JobRun result = apiInstance.stopJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.stopJobRun: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job
$jobId = jobId_example; // String | ID of the job containing the job run.
$runId = runId_example; // String | ID of the job run to delete.

try {
    $result = $api_instance->stopJobRun($projectId, $jobId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->stopJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job
my $jobId = jobId_example; # String | ID of the job containing the job run.
my $runId = runId_example; # String | ID of the job run to delete.

eval { 
    my $result = $api_instance->stopJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->stopJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job
jobId = jobId_example # String | ID of the job containing the job run.
runId = runId_example # String | ID of the job run to delete.

try: 
    # Stops a job run. Encoded as a custom method.
    api_response = api_instance.stop_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->stopJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job
Required
job_id*
String
ID of the job containing the job run.
Required
run_id*
String
ID of the job run to delete.
Required

Responses

Status: 200 - A successful response.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

stopModelDeployment

Stop a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to stop.
        try {
            ModelDeployment result = apiInstance.stopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to stop.
        try {
            ModelDeployment result = apiInstance.stopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the deployment to stop.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Stop a model deployment.
[apiInstance stopModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the deployment to stop.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopModelDeployment(projectId, modelId, buildId, deploymentId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the deployment to stop.

            try
            {
                // Stop a model deployment.
                ModelDeployment result = apiInstance.stopModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.stopModelDeployment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the deployment to stop.

try {
    $result = $api_instance->stopModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->stopModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the deployment to stop.

eval { 
    my $result = $api_instance->stopModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->stopModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the build containing the deployment.
deploymentId = deploymentId_example # String | ID of the deployment to stop.

try: 
    # Stop a model deployment.
    api_response = api_instance.stop_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->stopModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the build containing the deployment.
Required
deployment_id*
String
ID of the deployment to stop.
Required

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

replicas:
integer (int32)

Number of Replicas.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateAcceleratorBasedUserQuota

Update Accelerator based quota for user


/api/v2/nodelabels/quota

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/nodelabels/quota"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateAcceleratorBasedUserQuotaRequest body = ; // UpdateAcceleratorBasedUserQuotaRequest | 
        try {
            UpdateAcceleratorBasedUserQuotaResponse result = apiInstance.updateAcceleratorBasedUserQuota(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateAcceleratorBasedUserQuota");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateAcceleratorBasedUserQuotaRequest body = ; // UpdateAcceleratorBasedUserQuotaRequest | 
        try {
            UpdateAcceleratorBasedUserQuotaResponse result = apiInstance.updateAcceleratorBasedUserQuota(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateAcceleratorBasedUserQuota");
            e.printStackTrace();
        }
    }
}
UpdateAcceleratorBasedUserQuotaRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update Accelerator based quota for user
[apiInstance updateAcceleratorBasedUserQuotaWith:body
              completionHandler: ^(UpdateAcceleratorBasedUserQuotaResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateAcceleratorBasedUserQuotaRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAcceleratorBasedUserQuota(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAcceleratorBasedUserQuotaExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateAcceleratorBasedUserQuotaRequest(); // UpdateAcceleratorBasedUserQuotaRequest | 

            try
            {
                // Update Accelerator based quota for user
                UpdateAcceleratorBasedUserQuotaResponse result = apiInstance.updateAcceleratorBasedUserQuota(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateAcceleratorBasedUserQuota: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateAcceleratorBasedUserQuotaRequest | 

try {
    $result = $api_instance->updateAcceleratorBasedUserQuota($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateAcceleratorBasedUserQuota: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateAcceleratorBasedUserQuotaRequest->new(); # UpdateAcceleratorBasedUserQuotaRequest | 

eval { 
    my $result = $api_instance->updateAcceleratorBasedUserQuota(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateAcceleratorBasedUserQuota: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateAcceleratorBasedUserQuotaRequest | 

try: 
    # Update Accelerator based quota for user
    api_response = api_instance.update_accelerator_based_user_quota(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateAcceleratorBasedUserQuota: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
accelerator_based_user_quota:
[

The AcceleratorBasedUserQuota object containing some number of fields to update.

{
user_id:
string (int64)
accelerator_id:
string (int64)
gpu_quota:
string
accelerator_key:
string
accelerator_value:
string
}
]
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateAcceleratorLabelsAdminConfig

Update admin_config_max_per_workload in Node Labels


/api/v2/nodelabels/config

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/nodelabels/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateNodeLabelAdminConfigRequest body = ; // UpdateNodeLabelAdminConfigRequest | 
        try {
            UpdateNodeLabelAdminConfigResponse result = apiInstance.updateAcceleratorLabelsAdminConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateAcceleratorLabelsAdminConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateNodeLabelAdminConfigRequest body = ; // UpdateNodeLabelAdminConfigRequest | 
        try {
            UpdateNodeLabelAdminConfigResponse result = apiInstance.updateAcceleratorLabelsAdminConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateAcceleratorLabelsAdminConfig");
            e.printStackTrace();
        }
    }
}
UpdateNodeLabelAdminConfigRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update admin_config_max_per_workload in Node Labels
[apiInstance updateAcceleratorLabelsAdminConfigWith:body
              completionHandler: ^(UpdateNodeLabelAdminConfigResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateNodeLabelAdminConfigRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAcceleratorLabelsAdminConfig(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAcceleratorLabelsAdminConfigExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateNodeLabelAdminConfigRequest(); // UpdateNodeLabelAdminConfigRequest | 

            try
            {
                // Update admin_config_max_per_workload in Node Labels
                UpdateNodeLabelAdminConfigResponse result = apiInstance.updateAcceleratorLabelsAdminConfig(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateAcceleratorLabelsAdminConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateNodeLabelAdminConfigRequest | 

try {
    $result = $api_instance->updateAcceleratorLabelsAdminConfig($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateAcceleratorLabelsAdminConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateNodeLabelAdminConfigRequest->new(); # UpdateNodeLabelAdminConfigRequest | 

eval { 
    my $result = $api_instance->updateAcceleratorLabelsAdminConfig(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateAcceleratorLabelsAdminConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateNodeLabelAdminConfigRequest | 

try: 
    # Update admin_config_max_per_workload in Node Labels
    api_response = api_instance.update_accelerator_labels_admin_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateAcceleratorLabelsAdminConfig: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
id_max_gpu_workload:
map of id and admin_config_max_per_workload in an AcceleratorNodeLabel {
}
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateAcceleratorLabelsDefaultQuota

Update default_quota in Node Labels


/api/v2/nodelabels/default_quota

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/nodelabels/default_quota"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateNodeLabelDefaultQuotaRequest body = ; // UpdateNodeLabelDefaultQuotaRequest | 
        try {
            UpdateNodeLabelDefaultQuotaResponse result = apiInstance.updateAcceleratorLabelsDefaultQuota(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateAcceleratorLabelsDefaultQuota");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateNodeLabelDefaultQuotaRequest body = ; // UpdateNodeLabelDefaultQuotaRequest | 
        try {
            UpdateNodeLabelDefaultQuotaResponse result = apiInstance.updateAcceleratorLabelsDefaultQuota(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateAcceleratorLabelsDefaultQuota");
            e.printStackTrace();
        }
    }
}
UpdateNodeLabelDefaultQuotaRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update default_quota in Node Labels
[apiInstance updateAcceleratorLabelsDefaultQuotaWith:body
              completionHandler: ^(UpdateNodeLabelDefaultQuotaResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateNodeLabelDefaultQuotaRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAcceleratorLabelsDefaultQuota(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAcceleratorLabelsDefaultQuotaExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateNodeLabelDefaultQuotaRequest(); // UpdateNodeLabelDefaultQuotaRequest | 

            try
            {
                // Update default_quota in Node Labels
                UpdateNodeLabelDefaultQuotaResponse result = apiInstance.updateAcceleratorLabelsDefaultQuota(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateAcceleratorLabelsDefaultQuota: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateNodeLabelDefaultQuotaRequest | 

try {
    $result = $api_instance->updateAcceleratorLabelsDefaultQuota($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateAcceleratorLabelsDefaultQuota: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateNodeLabelDefaultQuotaRequest->new(); # UpdateNodeLabelDefaultQuotaRequest | 

eval { 
    my $result = $api_instance->updateAcceleratorLabelsDefaultQuota(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateAcceleratorLabelsDefaultQuota: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateNodeLabelDefaultQuotaRequest | 

try: 
    # Update default_quota in Node Labels
    api_response = api_instance.update_accelerator_labels_default_quota(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateAcceleratorLabelsDefaultQuota: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
id_default_quota:
map of id and default_quota in an AcceleratorNodeLabel {
}
}

Responses

Status: 200 - A successful response.

{
rows_affected:
Number of node labels updated with default_quota integer (int32)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateApplication

Update an application


/api/v2/projects/{project_id}/applications/{application.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/applications/{application.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Application body = ; // Application | The application containing some number of fields to update.
        String projectId = projectId_example; // String | The public project identifier
        String application.id = application.id_example; // String | public identifier of the application.
        try {
            Application result = apiInstance.updateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Application body = ; // Application | The application containing some number of fields to update.
        String projectId = projectId_example; // String | The public project identifier
        String application.id = application.id_example; // String | public identifier of the application.
        try {
            Application result = apiInstance.updateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateApplication");
            e.printStackTrace();
        }
    }
}
Application *body = ; // The application containing some number of fields to update.
String *projectId = projectId_example; // The public project identifier
String *application.id = application.id_example; // public identifier of the application.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an application
[apiInstance updateApplicationWith:body
    projectId:projectId
    application.id:application.id
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Application}} The application containing some number of fields to update.
var projectId = projectId_example; // {{String}} The public project identifier
var application.id = application.id_example; // {{String}} public identifier of the application.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateApplication(bodyprojectIdapplication.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Application(); // Application | The application containing some number of fields to update.
            var projectId = projectId_example;  // String | The public project identifier
            var application.id = application.id_example;  // String | public identifier of the application.

            try
            {
                // Update an application
                Application result = apiInstance.updateApplication(body, projectId, application.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateApplication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Application | The application containing some number of fields to update.
$projectId = projectId_example; // String | The public project identifier
$application.id = application.id_example; // String | public identifier of the application.

try {
    $result = $api_instance->updateApplication($body, $projectId, $application.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Application->new(); # Application | The application containing some number of fields to update.
my $projectId = projectId_example; # String | The public project identifier
my $application.id = application.id_example; # String | public identifier of the application.

eval { 
    my $result = $api_instance->updateApplication(body => $body, projectId => $projectId, application.id => $application.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Application | The application containing some number of fields to update.
projectId = projectId_example # String | The public project identifier
application.id = application.id_example # String | public identifier of the application.

try: 
    # Update an application
    api_response = api_instance.update_application(body, projectId, application.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application.id*
String
public identifier of the application.
Required
Body parameters
Name Description
body *
{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
name:
email:
}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

runtime_addon_identifiers:
[

The list of runtime addons that this application uses.

string
]
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
cdv_app:
Whether it is a CDV app or a non-CDV app boolean (boolean)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateCopilotEmbeddingModel

Update a Copilot embedding model.


/api/v2/copilot/embedding_models/{copilot_embedding_model.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/embedding_models/{copilot_embedding_model.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CopilotEmbeddingModel body = ; // CopilotEmbeddingModel | The embedding model containing some number of fields to update.
        String copilotEmbeddingModel.id = copilotEmbeddingModel.id_example; // String | ID of the model. Must be unique.
        try {
            CopilotEmbeddingModel result = apiInstance.updateCopilotEmbeddingModel(body, copilotEmbeddingModel.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CopilotEmbeddingModel body = ; // CopilotEmbeddingModel | The embedding model containing some number of fields to update.
        String copilotEmbeddingModel.id = copilotEmbeddingModel.id_example; // String | ID of the model. Must be unique.
        try {
            CopilotEmbeddingModel result = apiInstance.updateCopilotEmbeddingModel(body, copilotEmbeddingModel.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateCopilotEmbeddingModel");
            e.printStackTrace();
        }
    }
}
CopilotEmbeddingModel *body = ; // The embedding model containing some number of fields to update.
String *copilotEmbeddingModel.id = copilotEmbeddingModel.id_example; // ID of the model. Must be unique.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Copilot embedding model.
[apiInstance updateCopilotEmbeddingModelWith:body
    copilotEmbeddingModel.id:copilotEmbeddingModel.id
              completionHandler: ^(CopilotEmbeddingModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CopilotEmbeddingModel}} The embedding model containing some number of fields to update.
var copilotEmbeddingModel.id = copilotEmbeddingModel.id_example; // {{String}} ID of the model. Must be unique.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCopilotEmbeddingModel(bodycopilotEmbeddingModel.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCopilotEmbeddingModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CopilotEmbeddingModel(); // CopilotEmbeddingModel | The embedding model containing some number of fields to update.
            var copilotEmbeddingModel.id = copilotEmbeddingModel.id_example;  // String | ID of the model. Must be unique.

            try
            {
                // Update a Copilot embedding model.
                CopilotEmbeddingModel result = apiInstance.updateCopilotEmbeddingModel(body, copilotEmbeddingModel.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateCopilotEmbeddingModel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CopilotEmbeddingModel | The embedding model containing some number of fields to update.
$copilotEmbeddingModel.id = copilotEmbeddingModel.id_example; // String | ID of the model. Must be unique.

try {
    $result = $api_instance->updateCopilotEmbeddingModel($body, $copilotEmbeddingModel.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateCopilotEmbeddingModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CopilotEmbeddingModel->new(); # CopilotEmbeddingModel | The embedding model containing some number of fields to update.
my $copilotEmbeddingModel.id = copilotEmbeddingModel.id_example; # String | ID of the model. Must be unique.

eval { 
    my $result = $api_instance->updateCopilotEmbeddingModel(body => $body, copilotEmbeddingModel.id => $copilotEmbeddingModel.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateCopilotEmbeddingModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CopilotEmbeddingModel | The embedding model containing some number of fields to update.
copilotEmbeddingModel.id = copilotEmbeddingModel.id_example # String | ID of the model. Must be unique.

try: 
    # Update a Copilot embedding model.
    api_response = api_instance.update_copilot_embedding_model(body, copilotEmbeddingModel.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateCopilotEmbeddingModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_embedding_model.id*
String
ID of the model. Must be unique.
Required
Body parameters
Name Description
body *
Copilot Embedding Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Responses

Status: 200 - A successful response.

Copilot Embedding Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateCopilotModel

Update a Copilot model.


/api/v2/copilot/models/{copilot_model.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/models/{copilot_model.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CopilotModel body = ; // CopilotModel | The model containing some number of fields to update.
        String copilotModel.id = copilotModel.id_example; // String | ID of the model. Must be unique.
        try {
            CopilotModel result = apiInstance.updateCopilotModel(body, copilotModel.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CopilotModel body = ; // CopilotModel | The model containing some number of fields to update.
        String copilotModel.id = copilotModel.id_example; // String | ID of the model. Must be unique.
        try {
            CopilotModel result = apiInstance.updateCopilotModel(body, copilotModel.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateCopilotModel");
            e.printStackTrace();
        }
    }
}
CopilotModel *body = ; // The model containing some number of fields to update.
String *copilotModel.id = copilotModel.id_example; // ID of the model. Must be unique.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Copilot model.
[apiInstance updateCopilotModelWith:body
    copilotModel.id:copilotModel.id
              completionHandler: ^(CopilotModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CopilotModel}} The model containing some number of fields to update.
var copilotModel.id = copilotModel.id_example; // {{String}} ID of the model. Must be unique.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCopilotModel(bodycopilotModel.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCopilotModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CopilotModel(); // CopilotModel | The model containing some number of fields to update.
            var copilotModel.id = copilotModel.id_example;  // String | ID of the model. Must be unique.

            try
            {
                // Update a Copilot model.
                CopilotModel result = apiInstance.updateCopilotModel(body, copilotModel.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateCopilotModel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CopilotModel | The model containing some number of fields to update.
$copilotModel.id = copilotModel.id_example; // String | ID of the model. Must be unique.

try {
    $result = $api_instance->updateCopilotModel($body, $copilotModel.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateCopilotModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CopilotModel->new(); # CopilotModel | The model containing some number of fields to update.
my $copilotModel.id = copilotModel.id_example; # String | ID of the model. Must be unique.

eval { 
    my $result = $api_instance->updateCopilotModel(body => $body, copilotModel.id => $copilotModel.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateCopilotModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CopilotModel | The model containing some number of fields to update.
copilotModel.id = copilotModel.id_example # String | ID of the model. Must be unique.

try: 
    # Update a Copilot model.
    api_response = api_instance.update_copilot_model(body, copilotModel.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateCopilotModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_model.id*
String
ID of the model. Must be unique.
Required
Body parameters
Name Description
body *
Copilot Language Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Responses

Status: 200 - A successful response.

Copilot Language Model {
id:
string

ID of the model. Must be unique.

provider:
string

The Model Provider. E.g. 'Amazon Bedrock' or 'CML Serving'.

name:
string

The name of the model. E.g. 'Llama2 70b'. The combination of the provider and name fields must be unique.

endpoint:
string

For CMLServing models, the model endpoint string to connect to.

enabled:
boolean (boolean)

Whether a model is enabled for Copilot use.

default:
boolean (boolean)

Whether this model is the default model for Copilot use. Only one model can be the default Copilot model. Only enabled models can be the default.

provider_id:
string

The provider_id string for this model. AI Inference models should have "cloudera". For Amazon Bedrock models, Anthropic/Claude models should have "bedrock-chat", while others should have "bedrock".

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateDockerCredential

Update a Docker credential


/api/v2/dockercredentials/{docker_credential.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/dockercredentials/{docker_credential.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        DockerCredentialSensitive body = ; // DockerCredentialSensitive | The dockercredential object containing some number of fields to update.
        String dockerCredential.id = dockerCredential.id_example; // String | 
        try {
            DockerCredentialPublic result = apiInstance.updateDockerCredential(body, dockerCredential.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateDockerCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        DockerCredentialSensitive body = ; // DockerCredentialSensitive | The dockercredential object containing some number of fields to update.
        String dockerCredential.id = dockerCredential.id_example; // String | 
        try {
            DockerCredentialPublic result = apiInstance.updateDockerCredential(body, dockerCredential.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateDockerCredential");
            e.printStackTrace();
        }
    }
}
DockerCredentialSensitive *body = ; // The dockercredential object containing some number of fields to update.
String *dockerCredential.id = dockerCredential.id_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Docker credential
[apiInstance updateDockerCredentialWith:body
    dockerCredential.id:dockerCredential.id
              completionHandler: ^(DockerCredentialPublic output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{DockerCredentialSensitive}} The dockercredential object containing some number of fields to update.
var dockerCredential.id = dockerCredential.id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDockerCredential(bodydockerCredential.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateDockerCredentialExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new DockerCredentialSensitive(); // DockerCredentialSensitive | The dockercredential object containing some number of fields to update.
            var dockerCredential.id = dockerCredential.id_example;  // String | 

            try
            {
                // Update a Docker credential
                DockerCredentialPublic result = apiInstance.updateDockerCredential(body, dockerCredential.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateDockerCredential: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // DockerCredentialSensitive | The dockercredential object containing some number of fields to update.
$dockerCredential.id = dockerCredential.id_example; // String | 

try {
    $result = $api_instance->updateDockerCredential($body, $dockerCredential.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateDockerCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::DockerCredentialSensitive->new(); # DockerCredentialSensitive | The dockercredential object containing some number of fields to update.
my $dockerCredential.id = dockerCredential.id_example; # String | 

eval { 
    my $result = $api_instance->updateDockerCredential(body => $body, dockerCredential.id => $dockerCredential.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateDockerCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # DockerCredentialSensitive | The dockercredential object containing some number of fields to update.
dockerCredential.id = dockerCredential.id_example # String | 

try: 
    # Update a Docker credential
    api_response = api_instance.update_docker_credential(body, dockerCredential.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateDockerCredential: %s\n" % e)

Parameters

Path parameters
Name Description
docker_credential.id*
String
Required
Body parameters
Name Description
body *
{

For updating a docker credential we need to have a data object with both the sensitive fields and the ID.

id:
string
name:
string
server:
string
username:
string
password:
string
is_default:
boolean (boolean)
}

Responses

Status: 200 - A successful response.

{

List* type API calls should not respond with sensitive data, such as username or password. Therefore these API calls will return with this message.

id:
string
name:
string
server:
string
is_default:
boolean (boolean)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateExperiment

Update an existing experiment.


/api/v2/projects/{experiment.project_id}/experiments/{experiment.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{experiment.project_id}/experiments/{experiment.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Experiment body = ; // Experiment | 
        String experiment.projectId = experiment.projectId_example; // String | Project ID
        String experiment.id = experiment.id_example; // String | Unique identifier for the experiment.
        try {
            Experiment result = apiInstance.updateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Experiment body = ; // Experiment | 
        String experiment.projectId = experiment.projectId_example; // String | Project ID
        String experiment.id = experiment.id_example; // String | Unique identifier for the experiment.
        try {
            Experiment result = apiInstance.updateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperiment");
            e.printStackTrace();
        }
    }
}
Experiment *body = ; // 
String *experiment.projectId = experiment.projectId_example; // Project ID
String *experiment.id = experiment.id_example; // Unique identifier for the experiment.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an existing experiment.
[apiInstance updateExperimentWith:body
    experiment.projectId:experiment.projectId
    experiment.id:experiment.id
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Experiment}} 
var experiment.projectId = experiment.projectId_example; // {{String}} Project ID
var experiment.id = experiment.id_example; // {{String}} Unique identifier for the experiment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExperiment(bodyexperiment.projectIdexperiment.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Experiment(); // Experiment | 
            var experiment.projectId = experiment.projectId_example;  // String | Project ID
            var experiment.id = experiment.id_example;  // String | Unique identifier for the experiment.

            try
            {
                // Update an existing experiment.
                Experiment result = apiInstance.updateExperiment(body, experiment.projectId, experiment.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateExperiment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Experiment | 
$experiment.projectId = experiment.projectId_example; // String | Project ID
$experiment.id = experiment.id_example; // String | Unique identifier for the experiment.

try {
    $result = $api_instance->updateExperiment($body, $experiment.projectId, $experiment.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Experiment->new(); # Experiment | 
my $experiment.projectId = experiment.projectId_example; # String | Project ID
my $experiment.id = experiment.id_example; # String | Unique identifier for the experiment.

eval { 
    my $result = $api_instance->updateExperiment(body => $body, experiment.projectId => $experiment.projectId, experiment.id => $experiment.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Experiment | 
experiment.projectId = experiment.projectId_example # String | Project ID
experiment.id = experiment.id_example # String | Unique identifier for the experiment.

try: 
    # Update an existing experiment.
    api_response = api_instance.update_experiment(body, experiment.projectId, experiment.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
experiment.project_id*
String
Project ID
Required
experiment.id*
String
Unique identifier for the experiment.
Required
Body parameters
Name Description
body *
{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

user:
{

Abbreviated user information.

username:
name:
email:
}
}

Responses

Status: 200 - A successful response.

{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateExperimentRun

Update an experiment run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        ExperimentRun body = ; // ExperimentRun | 
        String projectId = projectId_example; // String | The project where the experiment run lives
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String run.id = run.id_example; // String | Unique identifier for the ExperimentRun.
        try {
            ExperimentRun result = apiInstance.updateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        ExperimentRun body = ; // ExperimentRun | 
        String projectId = projectId_example; // String | The project where the experiment run lives
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String run.id = run.id_example; // String | Unique identifier for the ExperimentRun.
        try {
            ExperimentRun result = apiInstance.updateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperimentRun");
            e.printStackTrace();
        }
    }
}
ExperimentRun *body = ; // 
String *projectId = projectId_example; // The project where the experiment run lives
String *experimentId = experimentId_example; // ID of the associated experiment.
String *run.id = run.id_example; // Unique identifier for the ExperimentRun.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an experiment run.
[apiInstance updateExperimentRunWith:body
    projectId:projectId
    experimentId:experimentId
    run.id:run.id
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{ExperimentRun}} 
var projectId = projectId_example; // {{String}} The project where the experiment run lives
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.
var run.id = run.id_example; // {{String}} Unique identifier for the ExperimentRun.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExperimentRun(bodyprojectIdexperimentIdrun.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new ExperimentRun(); // ExperimentRun | 
            var projectId = projectId_example;  // String | The project where the experiment run lives
            var experimentId = experimentId_example;  // String | ID of the associated experiment.
            var run.id = run.id_example;  // String | Unique identifier for the ExperimentRun.

            try
            {
                // Update an experiment run.
                ExperimentRun result = apiInstance.updateExperimentRun(body, projectId, experimentId, run.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateExperimentRun: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // ExperimentRun | 
$projectId = projectId_example; // String | The project where the experiment run lives
$experimentId = experimentId_example; // String | ID of the associated experiment.
$run.id = run.id_example; // String | Unique identifier for the ExperimentRun.

try {
    $result = $api_instance->updateExperimentRun($body, $projectId, $experimentId, $run.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::ExperimentRun->new(); # ExperimentRun | 
my $projectId = projectId_example; # String | The project where the experiment run lives
my $experimentId = experimentId_example; # String | ID of the associated experiment.
my $run.id = run.id_example; # String | Unique identifier for the ExperimentRun.

eval { 
    my $result = $api_instance->updateExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId, run.id => $run.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # ExperimentRun | 
projectId = projectId_example # String | The project where the experiment run lives
experimentId = experimentId_example # String | ID of the associated experiment.
run.id = run.id_example # String | Unique identifier for the ExperimentRun.

try: 
    # Update an experiment run.
    api_response = api_instance.update_experiment_run(body, projectId, experimentId, run.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project where the experiment run lives
Required
experiment_id*
String
ID of the associated experiment.
Required
run.id*
String
Unique identifier for the ExperimentRun.
Required
Body parameters
Name Description
body *
{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user:
{

Abbreviated user information.

username:
name:
email:
}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
params:
tags:
files:
registered_model_metadata:
}
}

Responses

Status: 200 - A successful response.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location (relative to the experiment run's root artifact directory) and metadata for artifacts.

{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}
]
registered_model_metadata:
[

RegisteredModelMetadata is used to show what model version is registered for this model.

{

RegisteredModelMetadata is used to represent model version metadata.

model_path:
string

model_path artifact folder name.

model_name:
string

model_name.

model_id:
string

model_id of the registered model id.

model_version_id:
string

model_version_id of the.

version_number:
integer (int32)

count of the model version.

run_id:
string

run_id of the experiment run.

created_at:
string (date-time)

created_at timestamp of model registered.

}
]
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateGroupPermissionForSyncedTeam

Update Group permission for a synced team


/api/v2/teams/{team_name}/groups/{group_id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/teams/{team_name}/groups/{group_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateGroupPermissionForSyncedTeamRequest body = ; // UpdateGroupPermissionForSyncedTeamRequest | 
        String teamName = teamName_example; // String | team name
        String groupId = groupId_example; // String | group id
        try {
            UpdateGroupPermissionForSyncedTeamResponse result = apiInstance.updateGroupPermissionForSyncedTeam(body, teamName, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateGroupPermissionForSyncedTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateGroupPermissionForSyncedTeamRequest body = ; // UpdateGroupPermissionForSyncedTeamRequest | 
        String teamName = teamName_example; // String | team name
        String groupId = groupId_example; // String | group id
        try {
            UpdateGroupPermissionForSyncedTeamResponse result = apiInstance.updateGroupPermissionForSyncedTeam(body, teamName, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateGroupPermissionForSyncedTeam");
            e.printStackTrace();
        }
    }
}
UpdateGroupPermissionForSyncedTeamRequest *body = ; // 
String *teamName = teamName_example; // team name
String *groupId = groupId_example; // group id

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update Group permission for a synced team
[apiInstance updateGroupPermissionForSyncedTeamWith:body
    teamName:teamName
    groupId:groupId
              completionHandler: ^(UpdateGroupPermissionForSyncedTeamResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateGroupPermissionForSyncedTeamRequest}} 
var teamName = teamName_example; // {{String}} team name
var groupId = groupId_example; // {{String}} group id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGroupPermissionForSyncedTeam(bodyteamNamegroupId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateGroupPermissionForSyncedTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateGroupPermissionForSyncedTeamRequest(); // UpdateGroupPermissionForSyncedTeamRequest | 
            var teamName = teamName_example;  // String | team name
            var groupId = groupId_example;  // String | group id

            try
            {
                // Update Group permission for a synced team
                UpdateGroupPermissionForSyncedTeamResponse result = apiInstance.updateGroupPermissionForSyncedTeam(body, teamName, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateGroupPermissionForSyncedTeam: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateGroupPermissionForSyncedTeamRequest | 
$teamName = teamName_example; // String | team name
$groupId = groupId_example; // String | group id

try {
    $result = $api_instance->updateGroupPermissionForSyncedTeam($body, $teamName, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateGroupPermissionForSyncedTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateGroupPermissionForSyncedTeamRequest->new(); # UpdateGroupPermissionForSyncedTeamRequest | 
my $teamName = teamName_example; # String | team name
my $groupId = groupId_example; # String | group id

eval { 
    my $result = $api_instance->updateGroupPermissionForSyncedTeam(body => $body, teamName => $teamName, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateGroupPermissionForSyncedTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateGroupPermissionForSyncedTeamRequest | 
teamName = teamName_example # String | team name
groupId = groupId_example # String | group id

try: 
    # Update Group permission for a synced team
    api_response = api_instance.update_group_permission_for_synced_team(body, teamName, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateGroupPermissionForSyncedTeam: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
team name
Required
group_id*
String (int64)
group id
Required
Body parameters
Name Description
body *
Parameters to update the group permission for a synced team {
team_name:
team name string
group_id:
group id string (int64)
permission:
permission string
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateJob

Updates a job.


/api/v2/projects/{project_id}/jobs/{job.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs/{job.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Job body = ; // Job | The job containing some number of fields to update.
        String projectId = projectId_example; // String | The project containing the job.
        String job.id = job.id_example; // String | Public identifier of the job.
Output only.
        try {
            Job result = apiInstance.updateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Job body = ; // Job | The job containing some number of fields to update.
        String projectId = projectId_example; // String | The project containing the job.
        String job.id = job.id_example; // String | Public identifier of the job.
Output only.
        try {
            Job result = apiInstance.updateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateJob");
            e.printStackTrace();
        }
    }
}
Job *body = ; // The job containing some number of fields to update.
String *projectId = projectId_example; // The project containing the job.
String *job.id = job.id_example; // Public identifier of the job.
Output only.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Updates a job.
[apiInstance updateJobWith:body
    projectId:projectId
    job.id:job.id
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Job}} The job containing some number of fields to update.
var projectId = projectId_example; // {{String}} The project containing the job.
var job.id = job.id_example; // {{String}} Public identifier of the job.
Output only.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateJob(bodyprojectIdjob.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Job(); // Job | The job containing some number of fields to update.
            var projectId = projectId_example;  // String | The project containing the job.
            var job.id = job.id_example;  // String | Public identifier of the job.
Output only.

            try
            {
                // Updates a job.
                Job result = apiInstance.updateJob(body, projectId, job.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Job | The job containing some number of fields to update.
$projectId = projectId_example; // String | The project containing the job.
$job.id = job.id_example; // String | Public identifier of the job.
Output only.

try {
    $result = $api_instance->updateJob($body, $projectId, $job.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Job->new(); # Job | The job containing some number of fields to update.
my $projectId = projectId_example; # String | The project containing the job.
my $job.id = job.id_example; # String | Public identifier of the job.
Output only.

eval { 
    my $result = $api_instance->updateJob(body => $body, projectId => $projectId, job.id => $job.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Job | The job containing some number of fields to update.
projectId = projectId_example # String | The project containing the job.
job.id = job.id_example # String | Public identifier of the job.
Output only.

try: 
    # Updates a job.
    api_response = api_instance.update_job(body, projectId, job.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project containing the job.
Required
job.id*
String
Public identifier of the job. Output only.
Required
Body parameters
Name Description
body *
{

One Job.

id:
string

Public identifier of the job. Output only.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created. Output only.

creator:
{

Abbreviated user information.

username:
name:
email:
}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes. Output only.

english_schedule:
string

English schedule. Output only.

arguments:
string

Arguments to the job.

type:
string

Type of job, whether it's "manual", "cron", or "dependent" Output only.

kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused. Output only.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job if this is a scheduled job. Output only.

updated_at:
string (date-time)

When the job was last updated. Output only.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
string

The runtime image identifier if this is a runtime job. Will be blank if using engines.

runtime_addon_identifiers:
[

The runtime addons associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill this job when it times out.

project:
{

Abbreviated project information.

public_identifier:
name:
default_project_engine:
slug:
}
owner:
{

Abbreviated user information.

username:
name:
email:
}
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Responses

Status: 200 - A successful response.

{

One Job.

id:
string

Public identifier of the job. Output only.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created. Output only.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes. Output only.

english_schedule:
string

English schedule. Output only.

arguments:
string

Arguments to the job.

type:
string

Type of job, whether it's "manual", "cron", or "dependent" Output only.

kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused. Output only.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job if this is a scheduled job. Output only.

updated_at:
string (date-time)

When the job was last updated. Output only.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
string

The runtime image identifier if this is a runtime job. Will be blank if using engines.

runtime_addon_identifiers:
[

The runtime addons associated with this job.

string
]
kill_on_timeout:
boolean (boolean)

Whether to kill this job when it times out.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
run_as:
userID of the service account that will be used to run the job. If 0 is returned, it means that job will run as the logged in user integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateMemberPermissionForSyncedTeam

Update member permission for a synced team


/api/v2/teams/{team_name}/group_members/{user_id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/teams/{team_name}/group_members/{user_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateMemberPermissionForSyncedTeamRequest body = ; // UpdateMemberPermissionForSyncedTeamRequest | 
        String teamName = teamName_example; // String | team name
        String userId = userId_example; // String | user id
        try {
            UpdateMemberPermissionForSyncedTeamResponse result = apiInstance.updateMemberPermissionForSyncedTeam(body, teamName, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateMemberPermissionForSyncedTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateMemberPermissionForSyncedTeamRequest body = ; // UpdateMemberPermissionForSyncedTeamRequest | 
        String teamName = teamName_example; // String | team name
        String userId = userId_example; // String | user id
        try {
            UpdateMemberPermissionForSyncedTeamResponse result = apiInstance.updateMemberPermissionForSyncedTeam(body, teamName, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateMemberPermissionForSyncedTeam");
            e.printStackTrace();
        }
    }
}
UpdateMemberPermissionForSyncedTeamRequest *body = ; // 
String *teamName = teamName_example; // team name
String *userId = userId_example; // user id

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update member permission for a synced team
[apiInstance updateMemberPermissionForSyncedTeamWith:body
    teamName:teamName
    userId:userId
              completionHandler: ^(UpdateMemberPermissionForSyncedTeamResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateMemberPermissionForSyncedTeamRequest}} 
var teamName = teamName_example; // {{String}} team name
var userId = userId_example; // {{String}} user id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateMemberPermissionForSyncedTeam(bodyteamNameuserId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMemberPermissionForSyncedTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateMemberPermissionForSyncedTeamRequest(); // UpdateMemberPermissionForSyncedTeamRequest | 
            var teamName = teamName_example;  // String | team name
            var userId = userId_example;  // String | user id

            try
            {
                // Update member permission for a synced team
                UpdateMemberPermissionForSyncedTeamResponse result = apiInstance.updateMemberPermissionForSyncedTeam(body, teamName, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateMemberPermissionForSyncedTeam: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateMemberPermissionForSyncedTeamRequest | 
$teamName = teamName_example; // String | team name
$userId = userId_example; // String | user id

try {
    $result = $api_instance->updateMemberPermissionForSyncedTeam($body, $teamName, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateMemberPermissionForSyncedTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateMemberPermissionForSyncedTeamRequest->new(); # UpdateMemberPermissionForSyncedTeamRequest | 
my $teamName = teamName_example; # String | team name
my $userId = userId_example; # String | user id

eval { 
    my $result = $api_instance->updateMemberPermissionForSyncedTeam(body => $body, teamName => $teamName, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateMemberPermissionForSyncedTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateMemberPermissionForSyncedTeamRequest | 
teamName = teamName_example # String | team name
userId = userId_example # String | user id

try: 
    # Update member permission for a synced team
    api_response = api_instance.update_member_permission_for_synced_team(body, teamName, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateMemberPermissionForSyncedTeam: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
team name
Required
user_id*
String (int64)
user id
Required
Body parameters
Name Description
body *
Parameters to update the team member permission for a synced team {
team_name:
team name string
user_id:
user id string (int64)
permission:
permission string
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateModel

Update a model.


/api/v2/projects/{project_id}/models/{model.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateSingleModel body = ; // UpdateSingleModel | The model containing some number of fields to update.
        String projectId = projectId_example; // String | ID of the project containing the model.
        String model.id = model.id_example; // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.
        try {
            Model result = apiInstance.updateModel(body, projectId, model.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateSingleModel body = ; // UpdateSingleModel | The model containing some number of fields to update.
        String projectId = projectId_example; // String | ID of the project containing the model.
        String model.id = model.id_example; // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.
        try {
            Model result = apiInstance.updateModel(body, projectId, model.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateModel");
            e.printStackTrace();
        }
    }
}
UpdateSingleModel *body = ; // The model containing some number of fields to update.
String *projectId = projectId_example; // ID of the project containing the model.
String *model.id = model.id_example; // ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a model.
[apiInstance updateModelWith:body
    projectId:projectId
    model.id:model.id
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateSingleModel}} The model containing some number of fields to update.
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var model.id = model.id_example; // {{String}} ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateModel(bodyprojectIdmodel.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateSingleModel(); // UpdateSingleModel | The model containing some number of fields to update.
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var model.id = model.id_example;  // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

            try
            {
                // Update a model.
                Model result = apiInstance.updateModel(body, projectId, model.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateModel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateSingleModel | The model containing some number of fields to update.
$projectId = projectId_example; // String | ID of the project containing the model.
$model.id = model.id_example; // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

try {
    $result = $api_instance->updateModel($body, $projectId, $model.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateSingleModel->new(); # UpdateSingleModel | The model containing some number of fields to update.
my $projectId = projectId_example; # String | ID of the project containing the model.
my $model.id = model.id_example; # String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

eval { 
    my $result = $api_instance->updateModel(body => $body, projectId => $projectId, model.id => $model.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateSingleModel | The model containing some number of fields to update.
projectId = projectId_example # String | ID of the project containing the model.
model.id = model.id_example # String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

try: 
    # Update a model.
    api_response = api_instance.update_model(body, projectId, model.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model.id*
String
ID of the model. A model CRN looks like <workspace CRN>/<UUID>. The ID is the UUID portion of the CRN.
Required
Body parameters
Name Description
body *
{

Parameters of a single model for the update flow.

id:
string

ID of the model. A model CRN looks like /. The ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

visibility:
string

Visibility of the model.

default_resources:
Details of a model's default resources {
cpu_millicores:
memory_mb:
nvidia_gpus:
}
default_replication_policy:
Details of a model's default replication policy {
num_replicas:
type:
}
run_as:
userID of the service account that should be used to deploy the model Pass a value <=0 to reset it and to make use of logged in user's ID for future deployments integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Responses

Status: 200 - A successful response.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

project:
{

Abbreviated project information.

public_identifier:
Project ID string
name:
Name of the Project string
default_project_engine:
Default Project Engine type. e.g. "ml_runtime" string
slug:
Slug information of the Project string
}
registered_model_id:
string

Registered Model ID reference to model Regisry.

visibility:
string

Visibility of the model.

default_resources:
Details of a model's default resources {
cpu_millicores:
New number of cpu millicores for the model string (int64)
memory_mb:
New number of memory (in MB) for the model string (int64)
nvidia_gpus:
New number of Nvidia GPUs for the model string (int64)
}
default_replication_policy:
Details of a model's default replication policy {
num_replicas:
Number of replicas to use for the model string (int64)
type:
Type of replication to use (i.e. fixed) string
}
run_as:
userID of the service account that should be used to create/deploy the model When it is empty, creator's userID is used integer (int32)
accelerator_label_id:
Label to use for node selecting gpu/accelerator string (int64)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateProject

Update an existing project.


/api/v2/projects/{project.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Project body = ; // Project | The project object containing some number of fields to update.
        String project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.
        try {
            Project result = apiInstance.updateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Project body = ; // Project | The project object containing some number of fields to update.
        String project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.
        try {
            Project result = apiInstance.updateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProject");
            e.printStackTrace();
        }
    }
}
Project *body = ; // The project object containing some number of fields to update.
String *project.id = project.id_example; // An opaque public identifier for the project.
Output only.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an existing project.
[apiInstance updateProjectWith:body
    project.id:project.id
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Project}} The project object containing some number of fields to update.
var project.id = project.id_example; // {{String}} An opaque public identifier for the project.
Output only.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProject(bodyproject.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Project(); // Project | The project object containing some number of fields to update.
            var project.id = project.id_example;  // String | An opaque public identifier for the project.
Output only.

            try
            {
                // Update an existing project.
                Project result = apiInstance.updateProject(body, project.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Project | The project object containing some number of fields to update.
$project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.

try {
    $result = $api_instance->updateProject($body, $project.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Project->new(); # Project | The project object containing some number of fields to update.
my $project.id = project.id_example; # String | An opaque public identifier for the project.
Output only.

eval { 
    my $result = $api_instance->updateProject(body => $body, project.id => $project.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Project | The project object containing some number of fields to update.
project.id = project.id_example # String | An opaque public identifier for the project.
Output only.

try: 
    # Update an existing project.
    api_response = api_instance.update_project(body, project.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateProject: %s\n" % e)

Parameters

Path parameters
Name Description
project.id*
String
An opaque public identifier for the project. Output only.
Required
Body parameters
Name Description
body *
{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
name:
email:
}
creator:
{

Abbreviated user information.

username:
name:
email:
}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
write:
admin:
business_user:
operator:
inherit:
}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

inherit:
boolean (boolean)

inherit is meant to be used only for teams.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

ephemeral_storage_request:
integer (int32)

The ephemeral storage requested for the project, in GB.

ephemeral_storage_limit:
integer (int32)

The ephemeral storage limit for the project, in GB.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateProjectFileMetadata

Update file metadata, such as renaming.


/api/v2/projects/{project_id}/files/{path}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/files/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        FileInfo body = ; // FileInfo | The FileInfo object representing the updated metadata for the file.
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file to update, relative to /home/cdsw
        try {
            FileInfo result = apiInstance.updateProjectFileMetadata(body, projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProjectFileMetadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        FileInfo body = ; // FileInfo | The FileInfo object representing the updated metadata for the file.
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file to update, relative to /home/cdsw
        try {
            FileInfo result = apiInstance.updateProjectFileMetadata(body, projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProjectFileMetadata");
            e.printStackTrace();
        }
    }
}
FileInfo *body = ; // The FileInfo object representing the updated metadata for the file.
String *projectId = projectId_example; // The identifier of the project that contains the file or directory.
String *path = path_example; // The path to the file to update, relative to /home/cdsw

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update file metadata, such as renaming.
[apiInstance updateProjectFileMetadataWith:body
    projectId:projectId
    path:path
              completionHandler: ^(FileInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{FileInfo}} The FileInfo object representing the updated metadata for the file.
var projectId = projectId_example; // {{String}} The identifier of the project that contains the file or directory.
var path = path_example; // {{String}} The path to the file to update, relative to /home/cdsw

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProjectFileMetadata(bodyprojectIdpath, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectFileMetadataExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new FileInfo(); // FileInfo | The FileInfo object representing the updated metadata for the file.
            var projectId = projectId_example;  // String | The identifier of the project that contains the file or directory.
            var path = path_example;  // String | The path to the file to update, relative to /home/cdsw

            try
            {
                // Update file metadata, such as renaming.
                FileInfo result = apiInstance.updateProjectFileMetadata(body, projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateProjectFileMetadata: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // FileInfo | The FileInfo object representing the updated metadata for the file.
$projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
$path = path_example; // String | The path to the file to update, relative to /home/cdsw

try {
    $result = $api_instance->updateProjectFileMetadata($body, $projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateProjectFileMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::FileInfo->new(); # FileInfo | The FileInfo object representing the updated metadata for the file.
my $projectId = projectId_example; # String | The identifier of the project that contains the file or directory.
my $path = path_example; # String | The path to the file to update, relative to /home/cdsw

eval { 
    my $result = $api_instance->updateProjectFileMetadata(body => $body, projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateProjectFileMetadata: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # FileInfo | The FileInfo object representing the updated metadata for the file.
projectId = projectId_example # String | The identifier of the project that contains the file or directory.
path = path_example # String | The path to the file to update, relative to /home/cdsw

try: 
    # Update file metadata, such as renaming.
    api_response = api_instance.update_project_file_metadata(body, projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateProjectFileMetadata: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project that contains the file or directory.
Required
path*
String
The path to the file to update, relative to /home/cdsw
Required
Body parameters
Name Description
body *
{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}

Responses

Status: 200 - A successful response.

{

Metadata of a single file or directory.

path:
string

The relative path to the file or directory. The path is relative to the base resource that this file represents. For example, if it's a project file/directory, it will be relative to /home/cdsw. Alternatively, if it's an experiment run artifact, it will be relative to the experiment run's root artifact directory.

is_dir:
boolean (boolean)

Whether the path is a directory. Output only.

file_size:
string (int64)

Size in bytes. Unset for directories. Output only.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateRegisteredModel

Update a Registered model.


/api/v2/registry/models

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/registry/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelRequest body = ; // UpdateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.updateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelRequest body = ; // UpdateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.updateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModel");
            e.printStackTrace();
        }
    }
}
UpdateRegisteredModelRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Registered model.
[apiInstance updateRegisteredModelWith:body
              completionHandler: ^(RegisteredModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRegisteredModelRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRegisteredModel(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRegisteredModelRequest(); // UpdateRegisteredModelRequest | 

            try
            {
                // Update a Registered model.
                RegisteredModel result = apiInstance.updateRegisteredModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRegisteredModel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRegisteredModelRequest | 

try {
    $result = $api_instance->updateRegisteredModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRegisteredModelRequest->new(); # UpdateRegisteredModelRequest | 

eval { 
    my $result = $api_instance->updateRegisteredModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRegisteredModelRequest | 

try: 
    # Update a Registered model.
    api_response = api_instance.update_registered_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRegisteredModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *
updateRegisteredModelRequest request to update a model's description {
model_id:
string

Model ID.

description:
string

Any description for the model.

visibility:
string
Default: PRIVATE
Enum: PRIVATE, PUBLIC
user_id:
string
}

Responses

Status: 200 - A successful response.

{
model_id:
string

Model ID.

name:
string

Model name.

description:
string

Model description.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
permission:
string

Permission of the user requesting the model.

visibility:
string
Default: PRIVATE
Enum: PRIVATE, PUBLIC
created_at:
string (date-time)

Model creation time.

updated_at:
string (date-time)

Model last updated time.

count:
integer (int32)

Model version count.

model_versions:
[

Registered model versions list.

{

RegisteredModelVersion is a model version.

model_id:
string

Model ID.

model_version_id:
string

Model version ID.

version_name:
string

Model version name.

number:
integer (int32)

Model version number.

notes:
string

Model version description.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
created_at:
string (date-time)

Model version creation time.

updated_at:
string (date-time)

Model version last updated time.

status:
string

Model version status.

model_version_metadata:
{

ModelVersionMetadata is a model version metadata.

mlops_type:
string
Default: MLFLOW
Enum: MLFLOW, SIMPLE
tags:
[

tags for model.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
workspace_url:
string

Workspace URL to track back the model origins.

project_id:
string

Project ID.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
mlflow_metadata:
{

MLflowMetadata is an mlflow model metadata.

experiment_id:
string

Experiment ID the run belongs to.

run_id:
string

Run ID.

metrics:
[

Metrics for the run.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
simple_metadata:
{

SimpleMetadata is a simple model metadata.

git_url:
string

git url for model code.

commit_id:
string

commit sha for model code.

metrics:
[

metrics for the model.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
}
tags:
[

Model version tags.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}
]
next_page_token:
string

next_page_token is a token to get the next page of results.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateRegisteredModelVersion

Update a Registered model version.


/api/v2/registry/models/{model_id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/registry/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelVersionRequest body = ; // UpdateRegisteredModelVersionRequest | 
        String modelId = modelId_example; // String | Model ID.
        try {
            RegisteredModelVersion result = apiInstance.updateRegisteredModelVersion(body, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelVersionRequest body = ; // UpdateRegisteredModelVersionRequest | 
        String modelId = modelId_example; // String | Model ID.
        try {
            RegisteredModelVersion result = apiInstance.updateRegisteredModelVersion(body, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
UpdateRegisteredModelVersionRequest *body = ; // 
String *modelId = modelId_example; // Model ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Registered model version.
[apiInstance updateRegisteredModelVersionWith:body
    modelId:modelId
              completionHandler: ^(RegisteredModelVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRegisteredModelVersionRequest}} 
var modelId = modelId_example; // {{String}} Model ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRegisteredModelVersion(bodymodelId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRegisteredModelVersionExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRegisteredModelVersionRequest(); // UpdateRegisteredModelVersionRequest | 
            var modelId = modelId_example;  // String | Model ID.

            try
            {
                // Update a Registered model version.
                RegisteredModelVersion result = apiInstance.updateRegisteredModelVersion(body, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRegisteredModelVersion: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRegisteredModelVersionRequest | 
$modelId = modelId_example; // String | Model ID.

try {
    $result = $api_instance->updateRegisteredModelVersion($body, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRegisteredModelVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRegisteredModelVersionRequest->new(); # UpdateRegisteredModelVersionRequest | 
my $modelId = modelId_example; # String | Model ID.

eval { 
    my $result = $api_instance->updateRegisteredModelVersion(body => $body, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRegisteredModelVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRegisteredModelVersionRequest | 
modelId = modelId_example # String | Model ID.

try: 
    # Update a Registered model version.
    api_response = api_instance.update_registered_model_version(body, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRegisteredModelVersion: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
Body parameters
Name Description
body *
{
model_id:
string

Model ID.

model_version_id:
string

Model version ID.

notes:
string

Model version description.

tags:
[

Model version tags.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}

Responses

Status: 200 - A successful response.

{

RegisteredModelVersion is a model version.

model_id:
string

Model ID.

model_version_id:
string

Model version ID.

version_name:
string

Model version name.

number:
integer (int32)

Model version number.

notes:
string

Model version description.

user:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
created_at:
string (date-time)

Model version creation time.

updated_at:
string (date-time)

Model version last updated time.

status:
string

Model version status.

model_version_metadata:
{

ModelVersionMetadata is a model version metadata.

mlops_type:
string
Default: MLFLOW
Enum: MLFLOW, SIMPLE
tags:
[

tags for model.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
workspace_url:
string

Workspace URL to track back the model origins.

project_id:
string

Project ID.

owner:
{

Abbreviated user information.

username:
name:
email:
}
mlflow_metadata:
{

MLflowMetadata is an mlflow model metadata.

experiment_id:
run_id:
metrics:
params:
tags:
}
simple_metadata:
{

SimpleMetadata is a simple model metadata.

git_url:
commit_id:
metrics:
params:
tags:
}
}
tags:
[

Model version tags.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateRuntimeAddonStatus

Update runtime addons


/api/v2/runtimeaddons:updatestatus

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimeaddons:updatestatus"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeAddonStatusRequest body = ; // UpdateRuntimeAddonStatusRequest | 
        try {
            UpdateRuntimeAddonStatusResponse result = apiInstance.updateRuntimeAddonStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeAddonStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeAddonStatusRequest body = ; // UpdateRuntimeAddonStatusRequest | 
        try {
            UpdateRuntimeAddonStatusResponse result = apiInstance.updateRuntimeAddonStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeAddonStatus");
            e.printStackTrace();
        }
    }
}
UpdateRuntimeAddonStatusRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update runtime addons
[apiInstance updateRuntimeAddonStatusWith:body
              completionHandler: ^(UpdateRuntimeAddonStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRuntimeAddonStatusRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRuntimeAddonStatus(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuntimeAddonStatusExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRuntimeAddonStatusRequest(); // UpdateRuntimeAddonStatusRequest | 

            try
            {
                // Update runtime addons
                UpdateRuntimeAddonStatusResponse result = apiInstance.updateRuntimeAddonStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRuntimeAddonStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRuntimeAddonStatusRequest | 

try {
    $result = $api_instance->updateRuntimeAddonStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRuntimeAddonStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRuntimeAddonStatusRequest->new(); # UpdateRuntimeAddonStatusRequest | 

eval { 
    my $result = $api_instance->updateRuntimeAddonStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRuntimeAddonStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRuntimeAddonStatusRequest | 

try: 
    # Update runtime addons
    api_response = api_instance.update_runtime_addon_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRuntimeAddonStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to update selected runtime addons.

status:
string
Default: UNKNOWN
Enum: UNKNOWN, AVAILABLE, DISABLED, DEPRECATED, DELETED, FAILED
ids:
[

List of runtime addons to update (not recommended).

integer (int32)
]
identifiers:
[

List of runtime addons to update.

string
]
}

Responses

Status: 200 - A successful response.

{

Response for updating runtimes.

rows_affected:
Number of runtime addons updated integer (int32)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateRuntimeRepo

Update a Runtime repo.


/api/v2/runtimerepos/{runtimerepo.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimerepos/{runtimerepo.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        RuntimeRepo body = ; // RuntimeRepo | The runtimerepo object containing some number of fields to update.
        Integer runtimerepo.id = 56; // Integer | The numeric identifier for this runtime repo
        try {
            RuntimeRepo result = apiInstance.updateRuntimeRepo(body, runtimerepo.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeRepo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        RuntimeRepo body = ; // RuntimeRepo | The runtimerepo object containing some number of fields to update.
        Integer runtimerepo.id = 56; // Integer | The numeric identifier for this runtime repo
        try {
            RuntimeRepo result = apiInstance.updateRuntimeRepo(body, runtimerepo.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeRepo");
            e.printStackTrace();
        }
    }
}
RuntimeRepo *body = ; // The runtimerepo object containing some number of fields to update.
Integer *runtimerepo.id = 56; // The numeric identifier for this runtime repo

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Runtime repo.
[apiInstance updateRuntimeRepoWith:body
    runtimerepo.id:runtimerepo.id
              completionHandler: ^(RuntimeRepo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{RuntimeRepo}} The runtimerepo object containing some number of fields to update.
var runtimerepo.id = 56; // {{Integer}} The numeric identifier for this runtime repo

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRuntimeRepo(bodyruntimerepo.id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuntimeRepoExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new RuntimeRepo(); // RuntimeRepo | The runtimerepo object containing some number of fields to update.
            var runtimerepo.id = 56;  // Integer | The numeric identifier for this runtime repo

            try
            {
                // Update a Runtime repo.
                RuntimeRepo result = apiInstance.updateRuntimeRepo(body, runtimerepo.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRuntimeRepo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // RuntimeRepo | The runtimerepo object containing some number of fields to update.
$runtimerepo.id = 56; // Integer | The numeric identifier for this runtime repo

try {
    $result = $api_instance->updateRuntimeRepo($body, $runtimerepo.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRuntimeRepo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::RuntimeRepo->new(); # RuntimeRepo | The runtimerepo object containing some number of fields to update.
my $runtimerepo.id = 56; # Integer | The numeric identifier for this runtime repo

eval { 
    my $result = $api_instance->updateRuntimeRepo(body => $body, runtimerepo.id => $runtimerepo.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRuntimeRepo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # RuntimeRepo | The runtimerepo object containing some number of fields to update.
runtimerepo.id = 56 # Integer | The numeric identifier for this runtime repo

try: 
    # Update a Runtime repo.
    api_response = api_instance.update_runtime_repo(body, runtimerepo.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRuntimeRepo: %s\n" % e)

Parameters

Path parameters
Name Description
runtimerepo.id*
Integer (int32)
The numeric identifier for this runtime repo
Required
Body parameters
Name Description
body *
{
id:
The numeric identifier for this runtime repo integer (int32)
name:
The name of this runtime repo string
url:
The URL of this runtime repo string
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

updateRuntimeStatus

Update the status of selected runtimes


/api/v2/runtimes:update

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimes:update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeStatusRequest body = ; // UpdateRuntimeStatusRequest | 
        try {
            UpdateRuntimeStatusResponse result = apiInstance.updateRuntimeStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeStatusRequest body = ; // UpdateRuntimeStatusRequest | 
        try {
            UpdateRuntimeStatusResponse result = apiInstance.updateRuntimeStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeStatus");
            e.printStackTrace();
        }
    }
}
UpdateRuntimeStatusRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update the status of selected runtimes
[apiInstance updateRuntimeStatusWith:body
              completionHandler: ^(UpdateRuntimeStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRuntimeStatusRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRuntimeStatus(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuntimeStatusExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRuntimeStatusRequest(); // UpdateRuntimeStatusRequest | 

            try
            {
                // Update the status of selected runtimes
                UpdateRuntimeStatusResponse result = apiInstance.updateRuntimeStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRuntimeStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRuntimeStatusRequest | 

try {
    $result = $api_instance->updateRuntimeStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRuntimeStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRuntimeStatusRequest->new(); # UpdateRuntimeStatusRequest | 

eval { 
    my $result = $api_instance->updateRuntimeStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRuntimeStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRuntimeStatusRequest | 

try: 
    # Update the status of selected runtimes
    api_response = api_instance.update_runtime_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRuntimeStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to update selected runtimes.

status:
string
Default: ENABLED
Enum: ENABLED, DISABLED, DEPRECATED
runtime_id:
[

List of runtimes to update (not recommended).

integer (int32)
]
image_identifier:
[

List of runtimes to update.

string
]
}

Responses

Status: 200 - A successful response.

{

Response for updating runtimes.

rows_affected:
Number of runtimes updated integer (int32)
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

uploadFile

upload a file as a multi-part upload


/api/v2/projects/{project_id}/files

Usage and SDK Samples

curl -X POST\
-H "Content-Type: multipart/form-data"\
"//api/v2/projects/{project_id}/files"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        byte[] file = file_example; // byte[] | 
        try {
            apiInstance.uploadFile(projectId, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#uploadFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        byte[] file = file_example; // byte[] | 
        try {
            apiInstance.uploadFile(projectId, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#uploadFile");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
byte[] *file = file_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// upload a file as a multi-part upload
[apiInstance uploadFileWith:projectId
    file:file
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var opts = { 
  'file': file_example // {{byte[]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadFile(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadFileExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var file = file_example;  // byte[] |  (optional) 

            try
            {
                // upload a file as a multi-part upload
                apiInstance.uploadFile(projectId, file);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.uploadFile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$file = file_example; // byte[] | 

try {
    $api_instance->uploadFile($projectId, $file);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->uploadFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $file = file_example; # byte[] | 

eval { 
    $api_instance->uploadFile(projectId => $projectId, file => $file);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->uploadFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
file = file_example # byte[] |  (optional)

try: 
    # upload a file as a multi-part upload
    api_instance.upload_file(projectId, file=file)
except ApiException as e:
    print("Exception when calling CMLServiceApi->uploadFile: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
Form parameters
Name Description
file
byte[] (binary)

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response.

validateCustomRuntime

Validate a runtime, given the URL to the image in the docker registry


/api/v2/runtimes:validate

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimes:validate?url=&docker_credential_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String url = url_example; // String | 
        String dockerCredentialId = dockerCredentialId_example; // String | 
        try {
            ValidateCustomRuntimeResponse result = apiInstance.validateCustomRuntime(url, dockerCredentialId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#validateCustomRuntime");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String url = url_example; // String | 
        String dockerCredentialId = dockerCredentialId_example; // String | 
        try {
            ValidateCustomRuntimeResponse result = apiInstance.validateCustomRuntime(url, dockerCredentialId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#validateCustomRuntime");
            e.printStackTrace();
        }
    }
}
String *url = url_example; //  (optional)
String *dockerCredentialId = dockerCredentialId_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Validate a runtime, given the URL to the image in the docker registry
[apiInstance validateCustomRuntimeWith:url
    dockerCredentialId:dockerCredentialId
              completionHandler: ^(ValidateCustomRuntimeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'url': url_example, // {{String}} 
  'dockerCredentialId': dockerCredentialId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateCustomRuntime(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateCustomRuntimeExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var url = url_example;  // String |  (optional) 
            var dockerCredentialId = dockerCredentialId_example;  // String |  (optional) 

            try
            {
                // Validate a runtime, given the URL to the image in the docker registry
                ValidateCustomRuntimeResponse result = apiInstance.validateCustomRuntime(url, dockerCredentialId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.validateCustomRuntime: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$url = url_example; // String | 
$dockerCredentialId = dockerCredentialId_example; // String | 

try {
    $result = $api_instance->validateCustomRuntime($url, $dockerCredentialId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->validateCustomRuntime: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $url = url_example; # String | 
my $dockerCredentialId = dockerCredentialId_example; # String | 

eval { 
    my $result = $api_instance->validateCustomRuntime(url => $url, dockerCredentialId => $dockerCredentialId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->validateCustomRuntime: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
url = url_example # String |  (optional)
dockerCredentialId = dockerCredentialId_example # String |  (optional)

try: 
    # Validate a runtime, given the URL to the image in the docker registry
    api_response = api_instance.validate_custom_runtime(url=url, dockerCredentialId=dockerCredentialId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->validateCustomRuntime: %s\n" % e)

Parameters

Query parameters
Name Description
url
String
docker_credential_id
String

Responses

Status: 200 - A successful response.

{
success:
boolean (boolean)
reason:
string
reason_data:
string
details:
{
registry:
string
editor:
string
kernel:
string
edition:
string
version:
string
maintenance_version:
integer (int32)
description:
string
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}