Skip to main content

nuvolos-client-api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: prod
  • Package version: 1.7.0
  • Generator version: 7.25.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

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 nuvolos_client_api

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 nuvolos_client_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import nuvolos_client_api
from nuvolos_client_api.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with nuvolos_client_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nuvolos_client_api.AppsV1Api(api_client)
    org_slug = 'org_slug_example' # str | 
    space_slug = 'space_slug_example' # str | 
    instance_slug = 'instance_slug_example' # str | 
    app_create = nuvolos_client_api.AppCreate() # AppCreate |  (optional)

    try:
        # Apps V1 Create App
        api_response = api_instance.create_app(org_slug, space_slug, instance_slug, app_create=app_create)
        print("The response of AppsV1Api->create_app:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AppsV1Api->create_app: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.eu1.nuvolos.cloud

Class Method HTTP request Description
AppsV1Api create_app POST /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/applications Apps V1 Create App
AppsV1Api derive_app POST /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}/derived_images Apps V1 Derive App
AppsV1Api get_apps GET /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug} Apps V1 List
DistributionV1Api distribute_content POST /distribution/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug} Distribution V1 Distribute
FilesV1Api get_files_in_files_area GET /files/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/files Files V1 List Files Area
FilesV1Api get_files_in_files_area_0 GET /files/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/files/{local_path} Files V1 List Files Area
FilesV1Api get_files_in_home_area GET /files/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/home Files V1 List Home Area
FilesV1Api get_files_in_home_area_0 GET /files/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/home/{local_path} Files V1 List Home Area
ImageFamiliesV1Api create_image_family PUT /image_families/v1 Image Families V1 Create
ImageFamiliesV1Api get_image_families GET /image_families/v1 Image Families V1 List
ImageFamiliesV1Api update_image_family PATCH /image_families/v1/{ifid} Image Families V1 Update
ImageLinksV1Api get_image_links GET /image_links/v1 Image Links V1 List
ImagesV1Api create_image PUT /images/v1 Images V1 Create
ImagesV1Api get_images GET /images/v1 Images V1 List
ImagesV1Api update_image PATCH /images/v1/{imid} Images V1 Update
InstancesV1Api create_group_instance POST /instances/v1/org/{org_slug}/space/{space_slug}/group Instances V1 Create Group Instance
InstancesV1Api create_instance POST /instances/v1/org/{org_slug}/space/{space_slug} Instances V1 Create Instance
InstancesV1Api create_snapshot POST /instances/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshots Instances V1 Create Snapshot
InstancesV1Api get_instance_members GET /instances/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/members Instances V1 List Members
InstancesV1Api get_instances GET /instances/v1/org/{org_slug}/space/{space_slug} Instances V1 List Instances
InstancesV1Api invite_instance_member POST /instances/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/invitations Instances V1 Invite Member
LFSV1Api cleanup_lfs_share POST /lfs/v1/org/{org_slug}/space/{space_slug}/shares/{afsid}/cleanup Schedule cleanup of a Ceph-backed LFS bucket.
LFSV1Api list_lfs_shares GET /lfs/v1/org/{org_slug}/space/{space_slug}/shares List all active LFS shares mounted in a space.
OrganizationsV1Api get_orgs GET /orgs/v1 Orgs V1 List Orgs
SessionsV1Api get_session_logs GET /sessions/v1/{session_id}/container/{container_name}/logs Sessions V1 Get Logs
SessionsV1Api get_sessions GET /sessions/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} Sessions V1 List Sessions
SnapshotsV1Api delete_snapshot DELETE /snapshots/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug} Snapshots V1 Delete Snapshot
SnapshotsV1Api get_snapshots GET /snapshots/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug} Snapshots V1 List Snapshots
SpacesV1Api get_space_members GET /spaces/v1/org/{org_slug}/space/{space_slug}/members Spaces V1 List Members
SpacesV1Api get_spaces GET /spaces/v1/org/{slug} Spaces V1 List Spaces
SpacesV1Api invite_space_member POST /spaces/v1/org/{org_slug}/space/{space_slug}/invitations Spaces V1 Invite Member
TablesV1Api delete_table DELETE /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug} Tables V1 Delete Table
TablesV1Api get_schema_ddl GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/get_ddl Tables V1 Get Schema Ddl
TablesV1Api get_table_columns GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug}/columns Tables V1 List Columns
TablesV1Api get_table_ddl GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug}/get_ddl Tables V1 Get Table Ddl
TablesV1Api get_tables GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug} Tables V1 List Tables
TablesV1Api rename_table PATCH /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug} Tables V1 Rename Table
TasksV1Api get_task GET /tasks/v1/{tkid} Tasks V1 Get Task
WorkloadsV1Api create_workload POST /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} Workloads V1 Start App
WorkloadsV1Api delete_workload DELETE /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} Workloads V1 Stop App
WorkloadsV1Api execute_command POST /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}/execute Workloads V1 Execute Command
WorkloadsV1Api get_nodepools GET /workloads/v1/org/{org_slug}/space/{space_slug}/nodepools Workloads V1 List Nodepools
WorkloadsV1Api get_workloads GET /workloads/v1 Workloads V1 List All Running
WorkloadsV1Api get_workloads_for_app GET /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} Workloads V1 List Workloads For App

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

Metadata

Release files for nuvolos-client-api 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nuvolos-client-api 1.7.0
File Size Uploaded
nuvolos_client_api-1.7.0.tar.gz 65.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nuvolos-client-api 1.7.0
File Interpreter ABI Platform
nuvolos_client_api-1.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 196.2 kB

Release files / nuvolos_client_api-1.7.0.tar.gz

Download URL nuvolos_client_api-1.7.0.tar.gz
Size 65.1 kB
Tags Source
SHA-256 checksum
How to use checksums
a37d4e42d42d802332b27b11415c7c49eab9dc3cfaf92a5c5545259844cd9df2
BLAKE2b-256 checksum
How to use checksums
82ef470efd80c4f2d84968b85d439e4c9780084360edcaafd51534cc1f6a360e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / nuvolos_client_api-1.7.0-py3-none-any.whl

Download URL nuvolos_client_api-1.7.0-py3-none-any.whl
Size 131.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b021c0e9b0f377a0ca5f3b5ea9660da80eb4f864080a51a9edf3b7e419a83f77
BLAKE2b-256 checksum
How to use checksums
453af00ff32661e4304e97492c707a7050ddef02b2f256955bc98c7605545ab5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

1.7.0 This release

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.0.2

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page