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.6.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:
        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
AppsV1Api derive_app POST /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}/derived_images
AppsV1Api get_apps GET /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}
DistributionV1Api distribute_content POST /distribution/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}
FilesV1Api get_files_in_files_area GET /files/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/files
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}
FilesV1Api get_files_in_home_area GET /files/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/home
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}
ImageFamiliesV1Api create_image_family PUT /image_families/v1
ImageFamiliesV1Api get_image_families GET /image_families/v1
ImageFamiliesV1Api update_image_family PATCH /image_families/v1/{ifid}
ImageLinksV1Api get_image_links GET /image_links/v1
ImagesV1Api create_image PUT /images/v1
ImagesV1Api get_images GET /images/v1
ImagesV1Api update_image PATCH /images/v1/{imid}
InstancesV1Api create_instance POST /instances/v1/org/{org_slug}/space/{space_slug}
InstancesV1Api create_snapshot POST /instances/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshots
InstancesV1Api get_instances GET /instances/v1/org/{org_slug}/space/{space_slug}
LFSV1Api cleanup_lfs_share POST /lfs/v1/org/{org_slug}/space/{space_slug}/shares/{afsid}/cleanup
LFSV1Api list_lfs_shares GET /lfs/v1/org/{org_slug}/space/{space_slug}/shares
OrganizationsV1Api get_orgs GET /orgs/v1
SessionsV1Api get_session_logs GET /sessions/v1/{session_id}/container/{container_name}/logs
SessionsV1Api get_sessions GET /sessions/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}
SnapshotsV1Api delete_snapshot DELETE /snapshots/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}
SnapshotsV1Api get_snapshots GET /snapshots/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}
SpacesV1Api get_spaces GET /spaces/v1/org/{slug}
TablesV1Api delete_table DELETE /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug}
TablesV1Api get_schema_ddl GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/get_ddl
TablesV1Api get_table_columns GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug}/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
TablesV1Api get_tables GET /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}
TablesV1Api rename_table PATCH /tables/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug}/table/{table_slug}
TasksV1Api get_task GET /tasks/v1/{tkid}
WorkloadsV1Api create_workload POST /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}
WorkloadsV1Api delete_workload DELETE /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}
WorkloadsV1Api execute_command POST /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}/execute
WorkloadsV1Api get_nodepools GET /workloads/v1/org/{org_slug}/space/{space_slug}/nodepools
WorkloadsV1Api get_workloads GET /workloads/v1
WorkloadsV1Api get_workloads_for_app GET /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}

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.6.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.6.0
File Size Uploaded
nuvolos_client_api-1.6.0.tar.gz 57.8 kB Details

Built distribution (wheel)

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

Total release size: 171.2 kB

Release files / nuvolos_client_api-1.6.0.tar.gz

Download URL nuvolos_client_api-1.6.0.tar.gz
Size 57.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e3fe4717fd2c8a6524d2dbf193258c490af7c3eae9864d65889f999b15cceab4
BLAKE2b-256 checksum
How to use checksums
0c243c020476075122b3c16ceeb97b74c514c348d72e5b4e9567f1e7a13f1878
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.6.0-py3-none-any.whl

Download URL nuvolos_client_api-1.6.0-py3-none-any.whl
Size 113.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
109d29be7708819c5780727e0647466d67befcddf53df7eb13abb65fc4c5c156
BLAKE2b-256 checksum
How to use checksums
12ee768c26e803510746f1dca13a465adebcd858d80e04f5e44b88638fe40658
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

1.7.0

2 release files

This release

1.6.0 This release

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