lambda-cloud-client

API for interacting with the Lambda GPU Cloud

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.4.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import lambda_cloud_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import lambda_cloud_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import lambda_cloud_client
from lambda_cloud_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.lambdalabs.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lambda_cloud_client.Configuration(
    host = "https://cloud.lambdalabs.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = lambda_cloud_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (auth-scheme): bearerAuth
configuration = lambda_cloud_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with lambda_cloud_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lambda_cloud_client.DefaultApi(api_client)
    add_ssh_key_request = lambda_cloud_client.AddSSHKeyRequest() # AddSSHKeyRequest | 

    try:
        # Add SSH key
        api_response = api_instance.add_ssh_key(add_ssh_key_request)
        print("The response of DefaultApi->add_ssh_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->add_ssh_key: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://cloud.lambdalabs.com/api/v1

Class	Method	HTTP request	Description
DefaultApi	add_ssh_key	POST /ssh-keys	Add SSH key
DefaultApi	delete_ssh_key	DELETE /ssh-keys/{id}	Delete SSH key
DefaultApi	get_instance	GET /instances/{id}	List details of a specific instance
DefaultApi	instance_types	GET /instance-types	Retrieve list of offered instance types
DefaultApi	launch_instance	POST /instance-operations/launch	Launch instances
DefaultApi	list_file_systems	GET /file-systems	List file systems
DefaultApi	list_instances	GET /instances	List running instances
DefaultApi	list_ssh_keys	GET /ssh-keys	List SSH keys
DefaultApi	restart_instance	POST /instance-operations/restart	Restart instances
DefaultApi	terminate_instance	POST /instance-operations/terminate	Terminate an instance

Documentation For Models

• AddSSHKey200Response
• AddSSHKeyRequest
• Error
• ErrorCode
• ErrorResponseBody
• FileSystem
• GetInstance200Response
• Instance
• InstanceType
• InstanceTypeSpecs
• InstanceTypes200Response
• InstanceTypes200ResponseDataValue
• LaunchInstance200Response
• LaunchInstance200ResponseData
• LaunchInstanceRequest
• ListFileSystems200Response
• ListInstances200Response
• ListSSHKeys200Response
• Region
• RestartInstance200Response
• RestartInstance200ResponseData
• RestartInstanceRequest
• SshKey
• TerminateInstance200Response
• TerminateInstance200ResponseData
• TerminateInstanceRequest
• User

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

bearerAuth

• Type: Bearer authentication (auth-scheme)

Author