Skip to content

flexifyio/flexify-api-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.13

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 check_token_and_get_user GET /backend/rest/auth/user 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 change_accounts PUT /backend/rest/endpoints/{endpoint-id}/storage-accounts Modified all storage accounts to the endpoint
EndpointsControllerApi change_buckets PUT /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets Replaces the list of storages attached 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 the list of endpoints for current user optionally filtering by name using SQL LIKE syntax
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
ImpersonationControllerApi add_impersonate_code POST /backend/rest/impersonate/codes addImpersonateCode
ImpersonationControllerApi add_impersonate_from_user POST /backend/rest/impersonate/from addImpersonateFromUser
ImpersonationControllerApi get_impersonate_codes_list GET /backend/rest/impersonate/codes getImpersonateCodesList
ImpersonationControllerApi get_impersonate_from_list GET /backend/rest/impersonate/from getImpersonateFromList
ImpersonationControllerApi get_impersonate_to_list GET /backend/rest/impersonate/to getImpersonateToList
ImpersonationControllerApi impersonate POST /backend/rest/impersonate/as/{userId} impersonate
ImpersonationControllerApi remove_impersonate_from_user DELETE /backend/rest/impersonate/from/{user-id} removeImpersonateFromUser
ImpersonationControllerApi remove_impersonate_from_user1 DELETE /backend/rest/impersonate/codes/{code} removeImpersonateFromUser
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
PartnerOrganizationsControllerApi get_all GET /backend/rest/partner/organizations getAll
PartnerSignUpCodesControllerApi create_code POST /backend/rest/distributor/codes createCode
PartnerSignUpCodesControllerApi create_code1 POST /backend/rest/partner/codes createCode
PartnerSignUpCodesControllerApi delete_code DELETE /backend/rest/distributor/codes/{code} deleteCode
PartnerSignUpCodesControllerApi delete_code1 DELETE /backend/rest/partner/codes/{code} deleteCode
PartnerSignUpCodesControllerApi get_all1 GET /backend/rest/distributor/codes getAll
PartnerSignUpCodesControllerApi get_all2 GET /backend/rest/partner/codes getAll
PartnerUsersControllerApi change_user_state PUT /backend/rest/distributor/users/{userId}/state Change user state
PartnerUsersControllerApi change_user_state1 PUT /backend/rest/partner/users/{userId}/state Change user state
PartnerUsersControllerApi change_user_state_by_external_id PUT /backend/rest/distributor/users/external/{externalId}/state Change user state by external ID
PartnerUsersControllerApi change_user_state_by_external_id1 PUT /backend/rest/partner/users/external/{externalId}/state Change user state by external ID
PartnerUsersControllerApi change_user_state_by_username PUT /backend/rest/distributor/users/username/{username}/state Change user state by username
PartnerUsersControllerApi change_user_state_by_username1 PUT /backend/rest/partner/users/username/{username}/state Change user state by username
PartnerUsersControllerApi create POST /backend/rest/distributor/users Create a user
PartnerUsersControllerApi create1 POST /backend/rest/partner/users Create a user
PartnerUsersControllerApi create_password_reset_token POST /backend/rest/distributor/users/{userId}/actions/create-password-reset-token Create password reset token
PartnerUsersControllerApi create_password_reset_token1 POST /backend/rest/partner/users/{userId}/actions/create-password-reset-token Create password reset token
PartnerUsersControllerApi create_password_reset_token_by_external_id POST /backend/rest/distributor/users/external/{externalId}/actions/create-password-reset-token Create password reset token by external ID
PartnerUsersControllerApi create_password_reset_token_by_external_id1 POST /backend/rest/partner/users/external/{externalId}/actions/create-password-reset-token Create password reset token by external ID
PartnerUsersControllerApi create_password_reset_token_by_username POST /backend/rest/distributor/users/username/{username}/actions/create-password-reset-token Create password reset token by username
PartnerUsersControllerApi create_password_reset_token_by_username1 POST /backend/rest/partner/users/username/{username}/actions/create-password-reset-token Create password reset token by username
PartnerUsersControllerApi delete_user DELETE /backend/rest/distributor/users/{userId} Delete user
PartnerUsersControllerApi delete_user1 DELETE /backend/rest/partner/users/{userId} Delete user
PartnerUsersControllerApi delete_user_by_external_id DELETE /backend/rest/distributor/users/external/{externalId} Delete user by external ID
PartnerUsersControllerApi delete_user_by_external_id1 DELETE /backend/rest/partner/users/external/{externalId} Delete user by external ID
PartnerUsersControllerApi delete_user_by_username DELETE /backend/rest/distributor/users/username/{username} Delete user by username
PartnerUsersControllerApi delete_user_by_username1 DELETE /backend/rest/partner/users/username/{username} Delete user by username
PartnerUsersControllerApi generate_token POST /backend/rest/distributor/users/{userId}/tokens Create token
PartnerUsersControllerApi generate_token1 POST /backend/rest/partner/users/{userId}/tokens Create token
PartnerUsersControllerApi generate_token_by_external_id POST /backend/rest/distributor/users/external/{externalId}/tokens Create token by external ID
PartnerUsersControllerApi generate_token_by_external_id1 POST /backend/rest/partner/users/external/{externalId}/tokens Create token by external ID
PartnerUsersControllerApi generate_token_by_username POST /backend/rest/distributor/users/username/{username}/tokens Create token by username
PartnerUsersControllerApi generate_token_by_username1 POST /backend/rest/partner/users/username/{username}/tokens Create token by username
PartnerUsersControllerApi get_user GET /backend/rest/distributor/users/{userId} Get user details
PartnerUsersControllerApi get_user1 GET /backend/rest/partner/users/{userId} Get user details
PartnerUsersControllerApi get_user_by_external_id GET /backend/rest/distributor/users/external/{externalId} Get user details by external ID
PartnerUsersControllerApi get_user_by_external_id1 GET /backend/rest/partner/users/external/{externalId} Get user details by external ID
PartnerUsersControllerApi get_user_by_username GET /backend/rest/distributor/users/username/{username} Get user details by username
PartnerUsersControllerApi get_user_by_username1 GET /backend/rest/partner/users/username/{username} Get user details by username
PartnerUsersControllerApi get_users GET /backend/rest/distributor/users Get all users
PartnerUsersControllerApi get_users1 GET /backend/rest/partner/users Get all users
PartnerUsersControllerApi send_password_reset_email POST /backend/rest/distributor/users/{userId}/actions/send-password-reset-email Set/reset password
PartnerUsersControllerApi send_password_reset_email1 POST /backend/rest/partner/users/{userId}/actions/send-password-reset-email Set/reset password
PartnerUsersControllerApi send_password_reset_email_by_external_id POST /backend/rest/distributor/users/external/{externalId}/actions/send-password-reset-email Set/reset password by external ID
PartnerUsersControllerApi send_password_reset_email_by_external_id1 POST /backend/rest/partner/users/external/{externalId}/actions/send-password-reset-email Set/reset password by external ID
PartnerUsersControllerApi send_password_reset_email_by_username POST /backend/rest/distributor/users/username/{username}/actions/send-password-reset-email Set/reset password by username
PartnerUsersControllerApi send_password_reset_email_by_username1 POST /backend/rest/partner/users/username/{username}/actions/send-password-reset-email Set/reset password by username
PartnerUsersControllerApi set_roles PUT /backend/rest/distributor/users/{userId}/roles setRoles
PartnerUsersControllerApi set_roles1 PUT /backend/rest/partner/users/{userId}/roles setRoles
PartnerUsersControllerApi set_roles_by_external_id PUT /backend/rest/distributor/users/external/{externalId}/roles setRolesByExternalId
PartnerUsersControllerApi set_roles_by_external_id1 PUT /backend/rest/partner/users/external/{externalId}/roles setRolesByExternalId
PartnerUsersControllerApi set_roles_by_username PUT /backend/rest/distributor/users/username/{username}/roles setRolesByUsername
PartnerUsersControllerApi set_roles_by_username1 PUT /backend/rest/partner/users/username/{username}/roles setRolesByUsername
PartnerUsersControllerApi update_user PUT /backend/rest/distributor/users/{userId} Update profile
PartnerUsersControllerApi update_user1 PUT /backend/rest/partner/users/{userId} Update profile
PartnerUsersControllerApi update_user_by_external_id PUT /backend/rest/distributor/users/external/{externalId} Update profile by external ID
PartnerUsersControllerApi update_user_by_external_id1 PUT /backend/rest/partner/users/external/{externalId} Update profile by external ID
PartnerUsersControllerApi update_user_by_username PUT /backend/rest/distributor/users/username/{username} Update profile by username
PartnerUsersControllerApi update_user_by_username1 PUT /backend/rest/partner/users/username/{username} Update profile by username
PaymentsControllerApi get_payment_options GET /backend/rest/pay/paddle/options getPaymentOptions
PaymentsControllerApi payment_fulfilled GET /backend/rest/pay/paddle/webhook paymentFulfilled
ProvidersControllerApi get_providers GET /backend/rest/providers Get all storage providers
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-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 get_bucket GET /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id} Get detailed stats for the bucket
StoragesControllerApi refresh_bucket POST /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id}/actions/refresh Refresh statistics of a single bucket
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