Skip to content

flexifyio/flexify-api-python

Repository files navigation

Python API Client for Flexify.IO Management Console

With Flexify.IO, storing your data in a cloud does not imply dependency on a single provider anymore!

By unlocking your application from the specific cloud vendor or protocol, you finally gain the freedom to decide when and where to store your data.

And we took care about data migration too!

  • Generate access token via /rest/auth + Authorize in Swagger UI using Bearer TOKEN + Enjoy Flexify.IO REST API

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.4.2
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit https://flexify.io/

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

Install directly from Github

pip install git+https://github.com/flexifyio/flexify-manage-api-client-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/flexifyio/flexify-manage-api-client-python.git)

Then import the package:

import flexify_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 flexify_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import flexify_api
from flexify_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = flexify_api.AuthenticationControllerApi()
authentication_request = flexify_api.AuthenticationRequest() # AuthenticationRequest | authenticationRequest

try:
    # Generate access token for user
    api_response = api_instance.authentication_request(authentication_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationControllerApi->authentication_request: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
AuthenticationControllerApi authentication_request POST /rest/auth Generate access token for user
AuthenticationControllerApi logout POST /rest/auth/logout Logout
BillingAccountControllerApi get_costs_for_current_user GET /rest/account/costs Get costs for current user
BillingAccountControllerApi get_current_user_billing_account GET /rest/account Get billing account for current user
BillingAccountControllerApi get_payments_for_current_user GET /rest/account/payments Get payments for current user
CloudLocationsControllerApi get_available_locations_for_current_user GET /rest/cloud-locations getAvailableLocationsForCurrentUser
EndpointsControllerApi attach_storage_to_endpoint POST /rest/endpoints/{endpoint-id}/storages Attach the storage to the endpoint
EndpointsControllerApi detach_storage_from_endpoint DELETE /rest/endpoints/{endpoint-id}/storages/{storage-id} Detach the storage from the endpoint
EndpointsControllerApi disable PUT /rest/endpoints/{endpoint-id}/actions/disable Disable the endpoint
EndpointsControllerApi enable PUT /rest/endpoints/{endpoint-id}/actions/enable Enable the endpoint
EndpointsControllerApi get_endpoint_details GET /rest/endpoints/{endpoint-id} Get endpoint details
EndpointsControllerApi get_endpoints_for_current_user GET /rest/endpoints Get endpoint for current user. This method will create new endpoint if no endpoints exist for user
EndpointsControllerApi set_default_storage PUT /rest/endpoints/{endpoint-id}/storages/{storage-id}/actions/set-as-default Set given storage as default for the endpoint
EndpointsControllerApi update_endpoint PUT /rest/endpoints/{endpoint-id} Update attributes of the endpoint
LogControllerApi get_log_for_current_user GET /rest/log getLogForCurrentUser
MigrationsControllerApi add_migration POST /rest/migrations Add new migration
MigrationsControllerApi get_migration GET /rest/migrations/{migration-id} Get migration by id. Only migration owner or administrator have access to the migration
MigrationsControllerApi get_migrations GET /rest/migrations Get all migrations for logged in user in pagged mode
MigrationsControllerApi hide_migration POST /rest/migrations/{migration-id}/hide Hide migration from UI
MigrationsControllerApi stop_migration POST /rest/migrations/{migration-id}/stop Stop (cancel) the migration
PaymentControllerApi get_payment_options GET /rest/pay/paddle/options getPaymentOptions
PaymentControllerApi payment_fulfilled GET /rest/pay/paddle/webhook paymentFulfilled
StoragesControllerApi add_storage_account POST /rest/storage-accounts Add Storage Account with an optional list of buckets
StoragesControllerApi add_storages POST /rest/storage-accounts/{storage-account-id}/storages Add buckets to the storage account and optionally attach them to endpoint
StoragesControllerApi delete_storage DELETE /rest/storage-accounts/{storage-account-id}/storages/{storage-id} Delete Storage
StoragesControllerApi delete_storages POST /rest/storage-accounts/actions/delete-storages Deletes storages
StoragesControllerApi generate_access_keys GET /rest/generate-access-keys Generate new access keys pair
StoragesControllerApi get_providers GET /rest/providers Get all storage providers
StoragesControllerApi get_storage_accounts GET /rest/storage-accounts Get all storage accounts for current user
StoragesControllerApi get_storages GET /rest/storage-accounts/{storage-account-id}/storages Get storages of the storage account
StoragesControllerApi refresh_storage POST /rest/storage-accounts/{storage-account-id}/storages/{storage-id}/actions/refresh Refresh storage
StoragesControllerApi refresh_storages POST /rest/storage-accounts/actions/refresh-storages Refresh storages
StoragesControllerApi request_buckets GET /rest/buckets Lists buckets of the external storage account
StoragesControllerApi request_buckets_for_storage_account GET /rest/storage-accounts/{storage-account-id}/buckets Retrieve buckets from external cloud storage account
UserControllerApi get_current_user GET /rest/user/current Get details information for logged in user
UserControllerApi request_reset_password POST /rest/user/request-reset-password requestResetPassword

Documentation For Models

Documentation For Authorization

Bearer

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

Contact us:

About

Flexify.IO Python API client

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages