Skip to content

flexifyio/flexify-api-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 can migrate data too!

  • Get API token
  • Enjoy Flexify.IO REST API
  • API version: 2.12.3-SNAPSHOT

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://api.flexify.io

Class Method HTTP request Description
AuthControllerApi authenticate POST /backend/rest/auth Generate new access token for the user
AuthControllerApi authorize POST /backend/rest/auth/authorize Authorization check of given token
AuthControllerApi get_config GET /backend/rest/auth/config Logout
AuthControllerApi logout POST /backend/rest/auth/logout Logout
BillingAccountControllerApi get_costs_for_current_user_billing_account GET /backend/rest/account/costs Get costs for current user
BillingAccountControllerApi get_current_user_billing_account GET /backend/rest/account Get billing account for current user
BillingAccountControllerApi get_payments_for_current_user GET /backend/rest/account/payments Get payments for current user
CloudLocationsControllerApi get_auto_deploy_available_locations_for_current_user GET /backend/rest/cloud-locations/auto-deploy getAutoDeployAvailableLocationsForCurrentUser
CloudLocationsControllerApi get_existing_available_locations_for_current_user GET /backend/rest/cloud-locations getExistingAvailableLocationsForCurrentUser
CostEstimateControllerApi estimate_migration_cost POST /backend/rest/cost/migration estimateMigrationCost
EndpointsControllerApi attach_accounts POST /backend/rest/endpoints/{endpoint-id}/storage-accounts Attach storage accounts to the endpoint
EndpointsControllerApi attach_buckets POST /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets Attach storages to the virtual bucket
EndpointsControllerApi create_endpoint POST /backend/rest/endpoints Creates new endpoint
EndpointsControllerApi create_virtual_bucket POST /backend/rest/endpoints/{endpoint-id}/virtual-buckets Creates new virtual bucket
EndpointsControllerApi delete DELETE /backend/rest/endpoints/{endpoint-id} Delete the endpoint
EndpointsControllerApi delete_virtual_bucket DELETE /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket} Deletes virtual bucket
EndpointsControllerApi detach_account DELETE /backend/rest/endpoints/{endpoint-id}/storage-accounts/{storage-account-id} Detach storage account from the endpoint
EndpointsControllerApi detach_bucket DELETE /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets/{bucket-id} Detach storage account from the endpoint
EndpointsControllerApi disable PUT /backend/rest/endpoints/{endpoint-id}/actions/disable Disable the endpoint
EndpointsControllerApi enable PUT /backend/rest/endpoints/{endpoint-id}/actions/enable Enable the endpoint
EndpointsControllerApi generate_access_keys GET /backend/rest/endpoints/generated-access-keys Generate new access keys pair
EndpointsControllerApi get_endpoint_details GET /backend/rest/endpoints/{endpoint-id} Get endpoint details
EndpointsControllerApi get_endpoints_for_current_user GET /backend/rest/endpoints Get endpoint for current user. This method will create new endpoint if no endpoints exist for user
EndpointsControllerApi set_attached_account_settings PUT /backend/rest/endpoints/{endpoint-id}/storage-accounts/{storage-account-id}/settings Modifies settings of the attached storage account
EndpointsControllerApi set_attached_bucket_settings PUT /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets/{bucket-id}/settings Modifies settings of the attached storage
EndpointsControllerApi set_virtual_bucket_settings PUT /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/settings Modifies virtual bucket configuration
EndpointsControllerApi update_endpoint_settings PUT /backend/rest/endpoints/{endpoint-id}/settings Update attributes of the endpoint
LogControllerApi get_log_for_current_user GET /backend/rest/log getLogForCurrentUser
MigrationsControllerApi add_migration POST /backend/rest/migrations Add new migration
MigrationsControllerApi get_migration GET /backend/rest/migrations/{migration-id} Get migration by id. Only migration owner or administrator have access to the migration
MigrationsControllerApi get_migrations GET /backend/rest/migrations Get all migrations for logged in user in paged mode
MigrationsControllerApi hide_all_migrations POST /backend/rest/migrations/actions/hide-all Mark all unfinished migrations as hidden UI
MigrationsControllerApi hide_migration POST /backend/rest/migrations/{migration-id}/actions/hide Mark migration as hidden
MigrationsControllerApi restart_slot POST /backend/rest/migrations/{migration-id}/mappings/{mapping-id}/slots/{slot}/actions/restart Mark migration as hidden
MigrationsControllerApi stop_migration POST /backend/rest/migrations/{migration-id}/actions/stop Stop (cancel) the migration
OAuthControllerApi get_app_info GET /backend/rest/oauth/app-info getAppInfo
PaymentsControllerApi get_payment_options GET /backend/rest/pay/paddle/options getPaymentOptions
PaymentsControllerApi payment_fulfilled GET /backend/rest/pay/paddle/webhook paymentFulfilled
StorageAccountsControllerApi add_storage_account POST /backend/rest/storage-accounts Add Storage Account with an optional list of buckets
StorageAccountsControllerApi delete_storage_account DELETE /backend/rest/storage-accounts/{storage-account-id} Deletes (hides) storage account and all its buckets/containers
StorageAccountsControllerApi delete_storage_accounts POST /backend/rest/storage-accounts/actions/delete Deletes (hides) a multiple storage accounts and all their buckets/containers
StorageAccountsControllerApi get_storage_account GET /backend/rest/storage-accounts/storage-accounts/{storage-account-id} Get storage account by id
StorageAccountsControllerApi get_storage_accounts GET /backend/rest/storage-accounts Get all storage accounts for current user
StorageAccountsControllerApi refresh_storage_account POST /backend/rest/storage-accounts/{storage-account-id}/actions/refresh Requests and updates list of buckets/containers for the storage account
StorageAccountsControllerApi refresh_storage_accounts POST /backend/rest/storage-accounts/actions/refresh Requests and updates list of buckets/containers for a list of storage accounts
StorageAccountsControllerApi set_storage_account_settings PUT /backend/rest/storage-accounts/{storage-account-id}/settings Updates storage account settings
StoragesControllerApi add_buckets POST /backend/rest/storage-accounts/{storage-account-id}/buckets Add buckets to the storage account
StoragesControllerApi delete_bucket DELETE /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id} Deletes (hides) a bucket/container
StoragesControllerApi delete_buckets POST /backend/rest/storage-accounts/actions/delete-buckets Deletes (hides) multiple buckets/containers
StoragesControllerApi get_providers GET /backend/rest/providers Get all storage providers
StoragesControllerApi refresh_bucket POST /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id}/actions/refresh Refresh statistics of a single bucket
StoragesControllerApi refresh_buckets POST /backend/rest/storage-accounts/actions/refresh-buckets Refresh statistics of multiple buckets
UserControllerApi get_current_user GET /backend/rest/user/current Get details of user corresponding to provided auth token
UserControllerApi request_delete POST /backend/rest/user/request-delete requestDelete
UserControllerApi request_reset_password POST /backend/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