References

Jobs

API

request_stop_job(job_id)

Request to stop job - sent by launcher

request_pause_job(job_id)

Request to pause job - sent by launcher

request_start_job(job_id)

Start running the job

request_top_from_job(job_id)

Request results of Top from docker - sent by launcher

request_logs_from_job(job_id)

Request results of logs from docker - sent by launcher

list_jobs([jobids, receiverids, oaids, …])

List of your jobs

download_job_results(job_id, path)

Download your job results when job is completed

Objects

Job(userid, senderid, receiverid[, …])

Details of a job

EJobStatus

An enumeration.

EJobRunningStatus

An enumeration.

EPaymentStatus

An enumeration.

JobLauncherUpdatedEvent(job)

JobLauncherResultsDownloadedEvent(resultsid, …)

StationJobUpdatedEvent(job)

JobTopEvent(job, top)

JobLogEvent(job, log)

Events

on_job_launcher_updated(func)

Callback will execute upon a job launcher updated event

on_job_launcher_results_downloaded(func)

Callback will execute upon a job launcher results downloaded event

on_station_job_updated(func)

Callback will execute upon a station job updated event

on_job_top(func)

Callback will execute upon a job top event

on_job_log(func)

Callback will execute upon a job log event

Machines

API

get_machines_by_id(machine_id)

Get machine’s info by its id

list_machines([mids, userids, page, items])

List all machines

update_concurrent_max_jobs(mid, amount)

Update the number of allowed concurrent jobs for a machine

Objects

Machine(name, userid, status, gpu, cpu, os, …)

EMachineStatus

An enumeration.

MachineStatusUpdateEvent(mid, status)

Events

on_machine_status_update(func)

Callback will execute upon a machine status update event

Profiles

API

self()

Get your Galileo profile

list_station_invites()

Get all your station invites

list_users([userids, usernames, …])

Get all Galileo users and their profiles

Objects

Profile([userid, username, mids, wallets])

ProfileWallet(wallet, public_key[, …])

Projects

API

create_project(name, description)

Create a project

upload(project_id, file, filename)

Upload a single file

run_job_on_station(project_id, station_id)

Run a job on a station

run_job_on_machine(project_id, station_id, …)

Run a job on a machine

Stations

API

list_stations([stationids, names, mids, …])

List of your Galileo stations

create_station(name, description[, userids])

Create a new station

invite_to_station(station_id, userids)

Invite user(s) to a station

accept_station_invite(station_id)

Accept an invitation to join a station

reject_station_invite(station_id)

Reject an invitation to join a station

request_to_join(station_id)

Request to join a station

approve_request_to_join(station_id, userids)

Admins and owners can approve members to join a station

reject_request_to_join(station_id, userids)

Admins and owners can reject members that want to join a station

leave_station(station_id)

Leave a station as a member

remove_member_from_station(station_id, userid)

Remove a member from a station

delete_station(station_id)

Permanently delete a station

add_machines_to_station(station_id, mids)

Add machines to a station

remove_machines_from_station(station_id, mids)

Remove machines from a station

add_volumes_to_station(station_id, name, …)

Add volumes to a station

add_host_path_to_volume(station_id, …)

Add host path to volume before running a job Host path is where the landing zone will store the results of a job

delete_host_path_from_volume(station_id, …)

Remove a host path Host path is where the landing zone will store the results of a job

remove_volume_from_station(station_id, volume_id)

Remove a volume from station

Objects

Station(stationid, name, description, users)

StationUser(stationuserid, stationid, …)

Volume([stationid, name, mount_point, …])

VolumeHostPath(volumehostpathid, volumeid, …)

EStationUserRole

An enumeration.

EVolumeAccess

An enumeration.

NewStationEvent(station)

StationAdminInviteSentEvent(stationid, userids)

StationUserInviteReceivedEvent(station)

StationAdminInviteAcceptedEvent(stationid, …)

StationMemberMemberEvent(stationid, userid)

StationUserInviteAcceptedEvent(stationid)

StationUserInviteRejectedEvent(stationid, userid)

StationAdminRequestReceivedEvent(stationid, …)

StationUserRequestSentEvent(stationid, userid)

StationAdminRequestAcceptedEvent(stationid, …)

StationUserRequestAcceptedEvent(stationid)

StationAdminRequestRejectedEvent(stationid, …)

StationUserRequestRejectedEvent(stationid)

StationAdminMemberRemovedEvent(stationid, userid)

StationAdminMachineRemovedEvent(stationid, mids)

StationMemberMemberRemovedEvent(stationid, …)

StationMemberMachineRemovedEvent(stationid, mids)

StationUserWithdrawnEvent(stationid, mids)

StationUserExpelledEvent(stationid)

StationAdminDestroyedEvent(stationid)

StationMemberDestroyedEvent(stationid)

StationUserInviteDestroyedEvent(stationid)

StationUserRequestDestroyedEvent(stationid)

StationAdminMachineAddedEvent(stationid, mids)

StationMemberMachineAddedEvent(stationid, mids)

StationAdminVolumeAddedEvent(stationid, volumes)

StationMemberVolumeAddedEvent(stationid, volumes)

StationAdminVolumeHostPathAddedEvent(…)

StationMemberVolumeHostPathAddedEvent(…)

StationAdminVolumeHostPathRemovedEvent(…)

StationMemberVolumeHostPathRemovedEvent(…)

StationAdminVolumeRemovedEvent(stationid, …)

StationMemberVolumeRemovedEvent(stationid, …)

Events

on_new_station(func)

Callback will execute upon a creation of a new station

on_station_admin_invite_sent(func)

Callback will execute upon an invite sent Emitted to admin of a station

on_station_user_invite_received(func)

Callback will execute upon a user receiving an invite to a station Emitted to the user that receives the invite

on_station_admin_invite_accepted(func)

Callback will execute upon an invite to a station being accepted Emitted to admin of station

on_station_member_member_added(func)

Callback will execute upon a member has been added (request has been approved or invitation has been accepted) Emitted to all members of a station

on_station_user_invite_accepted(func)

Callback will execute upon a user accepting an invite to a station Emitted to user who has accepted the invitation

on_station_admin_invite_rejected(func)

Callback will execute when an invite to a station has been rejected Emitted to admin of station

on_station_admin_request_received(func)

Callback will execute when a request to join the station has been received Emitted to admin of station

on_station_user_request_sent(func)

Callback will execute when a request to join the station has been sent Emitted to user requesting to join the station

on_station_admin_request_accepted(func)

Callback will execute when a request to join a station has been accepted Emitted to admin of station

on_station_user_request_accepted(func)

Callback will execute when a request to join a station has been accepted Emitted to user who sent the request

on_station_admin_request_rejected(func)

Callback will execute when a request to join a station has been rejected Emitted to admin of station

on_station_user_request_rejected(func)

Callback will execute when a request to join a station has been rejected Emitted to user who sent the request

on_station_admin_member_removed(func)

Callback will execute when a member has been removed from a station Emitted to admin of station

on_station_admin_machine_removed(func)

Callback will execute when a machine has been removed from a station Emitted to admin of station

on_station_member_member_removed(func)

Callback will execute when a member has been removed from a station Emitted to members of a station

on_station_member_machine_removed(func)

Callback will execute when a machine has been removed from a station Emitted to members of a station

on_station_user_withdrawn(func)

Callback will execute when a user has withdrawn from the station Emitted to user that is withdrawing

on_station_user_expelled(func)

Callback will execute when a user has been expelled from the station Emitted to user that has been expelled

on_station_admin_destroyed(func)

Callback will execute when a station has been destroyed Emitted to admin of station

on_station_member_destroyed(func)

Callback will execute when a station has been destroyed Emitted to member of station

on_station_user_invite_destroyed(func)

Callback will execute when a station has been destroyed Emitted to anyone who received an invite to join the station

on_station_user_request_destroyed(func)

Callback will execute when a station has been destroyed Emitted to anyone who sent a request to join to the station

on_station_admin_machine_added(func)

Callback will execute when a machine has been added to the station Emitted to admin of station

on_station_member_machine_added(func)

Callback will execute when a machine has been added to the station Emitted to members of station

on_station_admin_volume_added(func)

Callback will execute when a volume has been added to the station Emitted to admin of station

on_station_member_volume_added(func)

Callback will execute when a volume has been added to the station Emitted to members of station

on_station_admin_volume_host_path_added(func)

Callback will execute when a volume host path has been added Emitted to admin of station

on_station_member_volume_host_path_added(func)

Callback will execute when a volume host path has been added Emitted to members of station

on_station_admin_volume_host_path_removed(func)

Callback will execute when a volume host path has been removed Emitted to admin of station

on_station_member_volume_host_path_removed(func)

Callback will execute when a volume host path has been removed Emitted to members of station

on_station_admin_volume_removed(func)

Callback will execute when a volume has been removed Emitted to admin of station

on_station_member_volume_removed(func)

Callback will execute when a volume has been removed Emitted to members of station