FastAPI
API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:Download

User

Get User Information

Authorizations:
AuthorizationAPIKeyHeader
query Parameters
Contain Cards Info (boolean) or Contain Cards Info (null) (Contain Cards Info)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "department": "string",
  • "avatar_url": "string",
  • "referral_link": "string",
  • "api_key": "string",
  • "is_accepted_policy": true,
  • "balance": 0,
  • "is_connected_paypal": true,
  • "is_connected_stripe": true,
  • "is_auto_payment_enabled": true,
  • "cards_info": [
    ],
  • "total_add_credit_amount": 0,
  • "referral_message": "",
  • "is_submitted_survey": true,
  • "role": "string"
}

Get User Ssh Key

Authorizations:
AuthorizationAPIKeyHeader

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "ssh_key": "string"
}

Update User Ssh Key

Authorizations:
Authorization
Request Body schema: application/json
ssh_key
required
string (Ssh Key)

Responses

Request samples

Content type
application/json
{
  • "ssh_key": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "ssh_key": "string"
}

Get User Encrypt Key

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "encrypt_keys": [
    ]
}

Create User Encrypt Key

Authorizations:
Authorization
Request Body schema: application/json
required
Description (string) or Description (null) (Description)
Type (string) or Type (null) (Type)
Default: "storage_encrypt"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "type": "storage_encrypt"
}

Response samples

Content type
application/json
null

Update User Encrypt Key

Authorizations:
Authorization
query Parameters
user_key_file_id
required
integer (User Key File Id)
Request Body schema: application/json
required
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
null

Delete User Encrypt Key

Authorizations:
Authorization
query Parameters
user_key_file_id
required
integer (User Key File Id)

Responses

Response samples

Content type
application/json
null

Download User Encrypt Key

Authorizations:
Authorization
query Parameters
user_key_file_id
required
integer (User Key File Id)

Responses

Response samples

Content type
application/json
null

Machine Listings

Get Listing Machines

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Machine Listing

path Parameters
machine_listing_id
required
integer (Machine Listing Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "region": "string",
  • "country": "string",
  • "city": "string",
  • "listing_core": 0,
  • "listing_cpu": 0,
  • "listing_ram": 0,
  • "listing_storage": 0,
  • "status": "Sold",
  • "status_machine_listing": "string",
  • "ram_price": 0,
  • "cpu_price": 0,
  • "network_price": 0,
  • "storage_price": 0,
  • "ssh_terminal_access": false,
  • "web_terminal_access": true,
  • "is_sale_type_on_demand": true,
  • "is_sale_type_reserved": true,
  • "is_sale_type_reserved_1_month": false,
  • "is_sale_type_reserved_3_months": false,
  • "is_sale_type_reserved_1_year": false,
  • "is_sale_type_interruptiple": true,
  • "machine_id": 0,
  • "machine_unique_id": "string",
  • "machine_name": "string",
  • "reliability": "Enterprise",
  • "gpu_num": 0,
  • "gpu_name": "string",
  • "cpu_name": "string",
  • "vcpu": 0,
  • "ram": 0,
  • "storage": 0,
  • "tflops": 0,
  • "ml_performance": 0,
  • "network_upload_speed": 0,
  • "network_download_speed": 0,
  • "availability": 0,
  • "storage_write_speed": 0,
  • "storage_read_speed": 0,
  • "port_open_num": 0,
  • "network_latency": 0,
  • "tflops_price": 0,
  • "is_internet_facing": false,
  • "port_range": [ ],
  • "machine_like_rate": 0,
  • "machine_dislike_rate": 0,
  • "gpu_num_sold": 0,
  • "vcpu_sold": 0,
  • "ram_sold": 0,
  • "storage_sold": 0,
  • "gpu_price": 0,
  • "discount_one_month": 0,
  • "discount_three_month": 0,
  • "discount_one_year": 0,
  • "min_bid_price": 0,
  • "expiration_date": "2019-08-24T14:15:22Z",
  • "provider": "string",
  • "avatar_url": "string",
  • "gpu_num_free": 0,
  • "vcpu_free": 0,
  • "ram_free": 0,
  • "storage_free": 0,
  • "port_used": [ ],
  • "machine_source_id": 0,
  • "specs": [
    ]
}

Instances

Get Instances

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Instance

Authorizations:
Authorization
Request Body schema: application/json
machine_id
required
integer (Machine Id)
machine_listing_id
required
integer (Machine Listing Id)
status
string (Status)
Default: "Stopped"
status_rent
string (Status Rent)
Default: "OnDemand"
state
string (State)
Default: "free"
vcpu
required
integer (Vcpu)
ram
required
number (Ram)
storage
required
number (Storage)
template_vm_id
required
integer (Template Vm Id)
ssh_terminal_access
boolean (Ssh Terminal Access)
Default: true
web_terminal_access
boolean (Web Terminal Access)
Default: true
Encrypt Key File Id (integer) or Encrypt Key File Id (null) (Encrypt Key File Id)
start_jupyter_notebook
boolean (Start Jupyter Notebook)
Default: false
Ssh Connect (string) or Ssh Connect (null) (Ssh Connect)
Default: ""
Ssh Public Key (string) or Ssh Public Key (null) (Ssh Public Key)
Default: ""
Instance User (string) or Instance User (null) (Instance User)
Default: ""
Instance Password (string) or Instance Password (null) (Instance Password)
Default: ""
Gpu Number (integer) or Gpu Number (null) (Gpu Number)
Default: 1
port_used
Array of objects (Port Used)
Default: []
Label (string) or Label (null) (Label)
Default: ""
Bid Price (number) or Bid Price (null) (Bid Price)
Commitment Term (string) or Commitment Term (null) (Commitment Term)
ReservedTerm (integer) or null
Allow Convert To On Demand (boolean) or Allow Convert To On Demand (null) (Allow Convert To On Demand)

Responses

Request samples

Content type
application/json
{
  • "machine_id": 0,
  • "machine_listing_id": 0,
  • "status": "Stopped",
  • "status_rent": "OnDemand",
  • "state": "free",
  • "vcpu": 0,
  • "ram": 0,
  • "storage": 0,
  • "template_vm_id": 0,
  • "ssh_terminal_access": true,
  • "web_terminal_access": true,
  • "encrypt_key_file_id": 0,
  • "start_jupyter_notebook": false,
  • "ssh_connect": "",
  • "ssh_public_key": "",
  • "instance_user": "",
  • "instance_password": "",
  • "gpu_number": 1,
  • "port_used": [ ],
  • "label": "",
  • "bid_price": 0,
  • "commitment_term": "string",
  • "reserved_term": 720,
  • "allow_convert_to_on_demand": true
}

Response samples

Content type
application/json
null

Get Instance

Authorizations:
Authorization
path Parameters
instance_id
required
integer (Instance Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Status Instances

Authorizations:
Authorization
Request Body schema: application/json
required
Array of objects (Instances)

Responses

Request samples

Content type
application/json
{
  • "instances": [
    ]
}

Response samples

Content type
application/json
null