flexifyio/flexify-api-java

Flexify.IO Management API Java Client

Java API Client for Flexify IO Management

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!

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.flexify</groupId>
    <artifactId>management-apiclient</artifactId>
    <version>2.14.2</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.flexify:management-apiclient:2.14.2"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/management-apiclient-2.14.2.jar
• target/lib/*.jar

Getting Started

Please use our examples

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	checkTokenAndGetUser	GET /backend/rest/auth/user	Check of given token
AuthControllerApi	logout	POST /backend/rest/auth/logout	Logout
AuthSsoControllerApi	getConfig	GET /backend/rest/auth/sso/config	getConfig
AuthSsoControllerApi	getDeviceCode	GET /backend/rest/auth/sso/device-code	getDeviceCode
AuthSsoControllerApi	getTokenByDeviceCode	POST /backend/rest/auth/sso/token-by-device-code	getTokenByDeviceCode
AuthSsoControllerApi	refreshTokenForDeviceCodeFlow	POST /backend/rest/auth/sso/token-refresh	refreshTokenForDeviceCodeFlow
AzureIntegrationOAuthControllerApi	addAzureIntegration	POST /backend/rest/azure-integration	Add new Azure integration
AzureIntegrationOAuthControllerApi	authStorage	POST /backend/rest/azure-integration/{azure-integration-id}/actions/auth-storage	Authenticate Azure integration storage access
AzureIntegrationOAuthControllerApi	deleteAzureIntegration	DELETE /backend/rest/azure-integration/{azure-integration-id}	Deletes (hides) Azure integration by Id
AzureIntegrationOAuthControllerApi	getAzureIntegrations	GET /backend/rest/azure-integration	Get Azure integration by id
AzureIntegrationOAuthControllerApi	getConfigForAzureIntegration	GET /backend/rest/azure-integration/oauth/config	Get OAuth configuration to authorize Azure integration
AzureIntegrationOAuthControllerApi	getDeviceCodeForAzureIntegrationManagement	GET /backend/rest/azure-integration/oauth/device-code/management	Request device code to authorize Azure integration with device code flow (management access)
AzureIntegrationOAuthControllerApi	getDeviceCodeForAzureIntegrationStorage	GET /backend/rest/azure-integration/oauth/device-code/storage	Request device code to authorize Azure integration with device code flow (storage access)
AzureIntegrationOAuthControllerApi	getStorageAccountsFromAzure	GET /backend/rest/azure-integration/{azure-integration-id}/storage-accounts-list	Use Azure integration to get list of storage accounts from Azure
AzureIntegrationOAuthControllerApi	reauthAzureIntegration	POST /backend/rest/azure-integration/{azure-integration-id}/actions/reauth	Reauthenticate Azure integration
BillingAccountControllerApi	getCostsForCurrentUserBillingAccount	GET /backend/rest/account/costs	Get costs for current user
BillingAccountControllerApi	getCurrentUserBillingAccount	GET /backend/rest/account	Get billing account for current user
BillingAccountControllerApi	getPaymentsForCurrentUser	GET /backend/rest/account/payments	Get payments for current user
CloudLocationsControllerApi	getAutoDeployAvailableLocationsForCurrentUser	GET /backend/rest/cloud-locations/auto-deploy	getAutoDeployAvailableLocationsForCurrentUser
CloudLocationsControllerApi	getExistingAvailableLocationsForCurrentUser	GET /backend/rest/cloud-locations	getExistingAvailableLocationsForCurrentUser
ConfigControllerApi	getConfig1	GET /backend/rest/config	Get public Management Server config
CostEstimateControllerApi	estimateMigrationCost	POST /backend/rest/cost/migration	estimateMigrationCost
EndpointsControllerApi	attachAccounts	POST /backend/rest/endpoints/{endpoint-id}/storage-accounts	Attach storage accounts to the endpoint
EndpointsControllerApi	attachBuckets	POST /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets	Attach storages to the virtual bucket
EndpointsControllerApi	changeAccounts	PUT /backend/rest/endpoints/{endpoint-id}/storage-accounts	Modified all storage accounts to the endpoint
EndpointsControllerApi	changeBuckets	PUT /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets	Replaces the list of storages attached to the virtual bucket
EndpointsControllerApi	createEndpoint	POST /backend/rest/endpoints	Creates new endpoint
EndpointsControllerApi	createVirtualBucket	POST /backend/rest/endpoints/{endpoint-id}/virtual-buckets	Creates new virtual bucket
EndpointsControllerApi	delete	DELETE /backend/rest/endpoints/{endpoint-id}	Delete the endpoint
EndpointsControllerApi	deleteVirtualBucket	DELETE /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}	Deletes virtual bucket
EndpointsControllerApi	detachAccount	DELETE /backend/rest/endpoints/{endpoint-id}/storage-accounts/{storage-account-id}	Detach storage account from the endpoint
EndpointsControllerApi	detachBucket	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	generateAccessKeys	GET /backend/rest/endpoints/generated-access-keys	Generate new access keys pair
EndpointsControllerApi	getEndpointDetails	GET /backend/rest/endpoints/{endpoint-id}	Get endpoint details
EndpointsControllerApi	getEndpointSecretKey	GET /backend/rest/endpoints/{endpoint-id}/settings/secret-key	Get endpoint secret key
EndpointsControllerApi	getEndpointsForCurrentUser	GET /backend/rest/endpoints	Get the list of endpoints for current user optionally filtering by name or identity using SQL LIKE syntax
EndpointsControllerApi	setAttachedAccountSettings	PUT /backend/rest/endpoints/{endpoint-id}/storage-accounts/{storage-account-id}/settings	Modifies settings of the attached storage account
EndpointsControllerApi	setAttachedBucketSettings	PUT /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/buckets/{bucket-id}/settings	Modifies settings of the attached storage
EndpointsControllerApi	setVirtualBucketSettings	PUT /backend/rest/endpoints/{endpoint-id}/virtual-buckets/{virtual-bucket}/settings	Modifies virtual bucket configuration
EndpointsControllerApi	updateEndpointSettings	PUT /backend/rest/endpoints/{endpoint-id}/settings	Update attributes of the endpoint
ImpersonationControllerApi	addImpersonateCode	POST /backend/rest/impersonate/codes	addImpersonateCode
ImpersonationControllerApi	addImpersonateFromUser	POST /backend/rest/impersonate/from	addImpersonateFromUser
ImpersonationControllerApi	getImpersonateCodesList	GET /backend/rest/impersonate/codes	getImpersonateCodesList
ImpersonationControllerApi	getImpersonateFromList	GET /backend/rest/impersonate/from	getImpersonateFromList
ImpersonationControllerApi	getImpersonateToList	GET /backend/rest/impersonate/to	getImpersonateToList
ImpersonationControllerApi	impersonate	POST /backend/rest/impersonate/as/{userId}	impersonate
ImpersonationControllerApi	removeImpersonateFromUser	DELETE /backend/rest/impersonate/from/{user-id}	removeImpersonateFromUser
ImpersonationControllerApi	removeImpersonateFromUser1	DELETE /backend/rest/impersonate/codes/{code}	removeImpersonateFromUser
LogControllerApi	getLogForCurrentUser	GET /backend/rest/log	getLogForCurrentUser
MigrationsControllerApi	addMigration	POST /backend/rest/migrations	Add new migration
MigrationsControllerApi	getMigration	GET /backend/rest/migrations/{migration-id}	Get migration by id. Only migration owner or administrator have access to the migration
MigrationsControllerApi	getMigrations	GET /backend/rest/migrations	Get all migrations for logged in user in paged mode
MigrationsControllerApi	hideAllMigrations	POST /backend/rest/migrations/actions/hide-all	Mark all unfinished migrations as hidden UI
MigrationsControllerApi	hideMigration	POST /backend/rest/migrations/{migration-id}/actions/hide	Mark migration as hidden
MigrationsControllerApi	restartSlot	POST /backend/rest/migrations/{migration-id}/mappings/{mapping-id}/slots/{slot}/actions/restart	Mark migration as hidden
MigrationsControllerApi	stopMigration	POST /backend/rest/migrations/{migration-id}/actions/stop	Stop (cancel) the migration
PartnerOrganizationsControllerApi	getAll	GET /backend/rest/partner/organizations	getAll
PartnerOrganizationsControllerApi	getOrgLimits	GET /backend/rest/partner/organizations/{orgId}/limits	getOrgLimits
PartnerSignUpCodesControllerApi	createCode	POST /backend/rest/distributor/codes	createCode
PartnerSignUpCodesControllerApi	createCode1	POST /backend/rest/partner/codes	createCode
PartnerSignUpCodesControllerApi	deleteCode	DELETE /backend/rest/distributor/codes/{code}	deleteCode
PartnerSignUpCodesControllerApi	deleteCode1	DELETE /backend/rest/partner/codes/{code}	deleteCode
PartnerSignUpCodesControllerApi	getAll1	GET /backend/rest/distributor/codes	getAll
PartnerSignUpCodesControllerApi	getAll2	GET /backend/rest/partner/codes	getAll
PartnerUsersControllerApi	changeUserState	PUT /backend/rest/distributor/users/{userId}/state	Change user state
PartnerUsersControllerApi	changeUserState1	PUT /backend/rest/partner/users/{userId}/state	Change user state
PartnerUsersControllerApi	changeUserStateByExternalId	PUT /backend/rest/distributor/users/external/{externalId}/state	Change user state by external ID
PartnerUsersControllerApi	changeUserStateByExternalId1	PUT /backend/rest/partner/users/external/{externalId}/state	Change user state by external ID
PartnerUsersControllerApi	changeUserStateByUsername	PUT /backend/rest/distributor/users/username/{username}/state	Change user state by username
PartnerUsersControllerApi	changeUserStateByUsername1	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	createPasswordResetToken	POST /backend/rest/distributor/users/{userId}/actions/create-password-reset-token	Create password reset token
PartnerUsersControllerApi	createPasswordResetToken1	POST /backend/rest/partner/users/{userId}/actions/create-password-reset-token	Create password reset token
PartnerUsersControllerApi	createPasswordResetTokenByExternalId	POST /backend/rest/distributor/users/external/{externalId}/actions/create-password-reset-token	Create password reset token by external ID
PartnerUsersControllerApi	createPasswordResetTokenByExternalId1	POST /backend/rest/partner/users/external/{externalId}/actions/create-password-reset-token	Create password reset token by external ID
PartnerUsersControllerApi	createPasswordResetTokenByUsername	POST /backend/rest/distributor/users/username/{username}/actions/create-password-reset-token	Create password reset token by username
PartnerUsersControllerApi	createPasswordResetTokenByUsername1	POST /backend/rest/partner/users/username/{username}/actions/create-password-reset-token	Create password reset token by username
PartnerUsersControllerApi	deleteUser	DELETE /backend/rest/distributor/users/{userId}	Delete user
PartnerUsersControllerApi	deleteUser1	DELETE /backend/rest/partner/users/{userId}	Delete user
PartnerUsersControllerApi	deleteUserByExternalId	DELETE /backend/rest/distributor/users/external/{externalId}	Delete user by external ID
PartnerUsersControllerApi	deleteUserByExternalId1	DELETE /backend/rest/partner/users/external/{externalId}	Delete user by external ID
PartnerUsersControllerApi	deleteUserByUsername	DELETE /backend/rest/distributor/users/username/{username}	Delete user by username
PartnerUsersControllerApi	deleteUserByUsername1	DELETE /backend/rest/partner/users/username/{username}	Delete user by username
PartnerUsersControllerApi	generateToken	POST /backend/rest/distributor/users/{userId}/tokens	Create token
PartnerUsersControllerApi	generateToken1	POST /backend/rest/partner/users/{userId}/tokens	Create token
PartnerUsersControllerApi	generateTokenByExternalId	POST /backend/rest/distributor/users/external/{externalId}/tokens	Create token by external ID
PartnerUsersControllerApi	generateTokenByExternalId1	POST /backend/rest/partner/users/external/{externalId}/tokens	Create token by external ID
PartnerUsersControllerApi	generateTokenByUsername	POST /backend/rest/distributor/users/username/{username}/tokens	Create token by username
PartnerUsersControllerApi	generateTokenByUsername1	POST /backend/rest/partner/users/username/{username}/tokens	Create token by username
PartnerUsersControllerApi	getAllUsersPageable	GET /backend/rest/distributor/users/search	Get users with search, sorting and pagination
PartnerUsersControllerApi	getAllUsersPageable1	GET /backend/rest/partner/users/search	Get users with search, sorting and pagination
PartnerUsersControllerApi	getUser	GET /backend/rest/distributor/users/{userId}	Get user details
PartnerUsersControllerApi	getUser1	GET /backend/rest/partner/users/{userId}	Get user details
PartnerUsersControllerApi	getUserByExternalId	GET /backend/rest/distributor/users/external/{externalId}	Get user details by external ID
PartnerUsersControllerApi	getUserByExternalId1	GET /backend/rest/partner/users/external/{externalId}	Get user details by external ID
PartnerUsersControllerApi	getUserByUsername	GET /backend/rest/distributor/users/username/{username}	Get user details by username
PartnerUsersControllerApi	getUserByUsername1	GET /backend/rest/partner/users/username/{username}	Get user details by username
PartnerUsersControllerApi	getUsers	GET /backend/rest/distributor/users	Get all users
PartnerUsersControllerApi	getUsers1	GET /backend/rest/partner/users	Get all users
PartnerUsersControllerApi	sendPasswordResetEmail	POST /backend/rest/distributor/users/{userId}/actions/send-password-reset-email	Set/reset password
PartnerUsersControllerApi	sendPasswordResetEmail1	POST /backend/rest/partner/users/{userId}/actions/send-password-reset-email	Set/reset password
PartnerUsersControllerApi	sendPasswordResetEmailByExternalId	POST /backend/rest/distributor/users/external/{externalId}/actions/send-password-reset-email	Set/reset password by external ID
PartnerUsersControllerApi	sendPasswordResetEmailByExternalId1	POST /backend/rest/partner/users/external/{externalId}/actions/send-password-reset-email	Set/reset password by external ID
PartnerUsersControllerApi	sendPasswordResetEmailByUsername	POST /backend/rest/distributor/users/username/{username}/actions/send-password-reset-email	Set/reset password by username
PartnerUsersControllerApi	sendPasswordResetEmailByUsername1	POST /backend/rest/partner/users/username/{username}/actions/send-password-reset-email	Set/reset password by username
PartnerUsersControllerApi	setLimits	PUT /backend/rest/distributor/users/{userId}/limits	Set custom user limits by partner
PartnerUsersControllerApi	setLimits1	PUT /backend/rest/partner/users/{userId}/limits	Set custom user limits by partner
PartnerUsersControllerApi	setLimitsByExternalId	PUT /backend/rest/distributor/users/external/{externalId}/limits	setLimitsByExternalId
PartnerUsersControllerApi	setLimitsByExternalId1	PUT /backend/rest/partner/users/external/{externalId}/limits	setLimitsByExternalId
PartnerUsersControllerApi	setLimitsByUsername	PUT /backend/rest/distributor/users/username/{username}/limits	setLimitsByUsername
PartnerUsersControllerApi	setLimitsByUsername1	PUT /backend/rest/partner/users/username/{username}/limits	setLimitsByUsername
PartnerUsersControllerApi	setRoles	PUT /backend/rest/distributor/users/{userId}/roles	setRoles
PartnerUsersControllerApi	setRoles1	PUT /backend/rest/partner/users/{userId}/roles	setRoles
PartnerUsersControllerApi	setRolesByExternalId	PUT /backend/rest/distributor/users/external/{externalId}/roles	setRolesByExternalId
PartnerUsersControllerApi	setRolesByExternalId1	PUT /backend/rest/partner/users/external/{externalId}/roles	setRolesByExternalId
PartnerUsersControllerApi	setRolesByUsername	PUT /backend/rest/distributor/users/username/{username}/roles	setRolesByUsername
PartnerUsersControllerApi	setRolesByUsername1	PUT /backend/rest/partner/users/username/{username}/roles	setRolesByUsername
PartnerUsersControllerApi	updateUser	PUT /backend/rest/distributor/users/{userId}	Update profile
PartnerUsersControllerApi	updateUser1	PUT /backend/rest/partner/users/{userId}	Update profile
PartnerUsersControllerApi	updateUserByExternalId	PUT /backend/rest/distributor/users/external/{externalId}	Update profile by external ID
PartnerUsersControllerApi	updateUserByExternalId1	PUT /backend/rest/partner/users/external/{externalId}	Update profile by external ID
PartnerUsersControllerApi	updateUserByUsername	PUT /backend/rest/distributor/users/username/{username}	Update profile by username
PartnerUsersControllerApi	updateUserByUsername1	PUT /backend/rest/partner/users/username/{username}	Update profile by username
PaymentsControllerApi	getPaymentOptions	GET /backend/rest/pay/paddle/options	getPaymentOptions
PaymentsControllerApi	paymentFulfilled	GET /backend/rest/pay/paddle/webhook	paymentFulfilled
ProvidersControllerApi	getProviders	GET /backend/rest/providers	Get all storage providers
StorageAccountsControllerApi	addStorageAccount	POST /backend/rest/storage-accounts	Add Storage Account with an optional list of buckets
StorageAccountsControllerApi	addStorageAccountsWithAzureIntegration	POST /backend/rest/storage-accounts/azure-integration	Add multiple storage accounts with Azure integration
StorageAccountsControllerApi	deleteStorageAccount	DELETE /backend/rest/storage-accounts/{storage-account-id}	Deletes (hides) storage account and all its buckets/containers
StorageAccountsControllerApi	getStorageAccount	GET /backend/rest/storage-accounts/{storage-account-id}	Get storage account by id
StorageAccountsControllerApi	getStorageAccounts	GET /backend/rest/storage-accounts	Get all storage accounts for current user
StorageAccountsControllerApi	reauthStorageAccount	POST /backend/rest/storage-accounts/{storage-account-id}/reauth	Reauthenticate storage account
StorageAccountsControllerApi	refreshStorageAccount	POST /backend/rest/storage-accounts/{storage-account-id}/actions/refresh	Requests and updates list of buckets/containers for the storage account
StorageAccountsControllerApi	setStorageAccountSettings	PUT /backend/rest/storage-accounts/{storage-account-id}/settings	Updates storage account settings
StorageAccountsOAuthControllerApi	getConfig2	GET /backend/rest/storage-accounts/oauth/config	getConfig
StorageAccountsOAuthControllerApi	getDeviceCode1	GET /backend/rest/storage-accounts/oauth/device-code	getDeviceCode
StoragesControllerApi	addBuckets	POST /backend/rest/storage-accounts/{storage-account-id}/buckets	Add buckets to the storage account
StoragesControllerApi	deleteBucket	DELETE /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id}	Deletes (hides) a bucket/container
StoragesControllerApi	getBucket	GET /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id}	Get detailed stats for the bucket
StoragesControllerApi	refreshBucket	POST /backend/rest/storage-accounts/{storage-account-id}/buckets/{bucket-id}/actions/refresh	Refresh statistics of a single bucket
UserControllerApi	changeMicrosoftSso	POST /backend/rest/user/current/sso-microsoft	changeMicrosoftSso
UserControllerApi	getCurrentUser	GET /backend/rest/user/current	Get details of user corresponding to provided auth token
UserControllerApi	requestDelete	POST /backend/rest/user/request-delete	requestDelete
UserControllerApi	requestResetPassword	POST /backend/rest/user/request-reset-password	requestResetPassword

Documentation for Models

• AccessKeysPair
• AddBucketsRequest
• AddImpersonateCodeRequest
• AddImpersonateFromUserRequest
• AddMigrationRequest
• AddMigrationRequestMapping
• AddStorageAccountRequest
• AddStorageAccountsWithAzureLinkRequest
• AuthCheckTokenAndGetUserResponse
• AuthenticationRequest
• AuthenticationResponse
• AzureIntegration
• AzureStorageAccountInfo
• AzureSubscriptionInfoWithStorages
• BillingAccount
• Bucket
• BucketStat
• ChangePasswordRequest
• ChangeSsoMicrosoftRequest
• CleanupStat
• CloudLocation
• CloudLocationReq
• CloudLocationRes
• CostDetails
• CreateUserRequest
• CreateVirtualBucketRequest
• Distributor
• DtoMappingCostEstimate
• DtoMappingCostEstimateEntry
• DtoMigrationCostEstimate
• EndpointDetails
• EndpointSecretResponse
• EndpointSettingsReq
• EndpointSettingsRes
• EndpointStat
• EndpointStorageAccount
• EndpointStorageAccountSettings
• FinishOAuthParams
• IdResponse
• IdsList
• ImpersonateUser
• InformationAboutAuthenticationToken
• LogEntry
• LogEvent
• LogoutRequest
• Mapping
• MappingStat
• MarkerPageLogEntry
• MicrosoftOAuthConfig
• Migration
• MigrationSettings
• MigrationSettingsReq
• MigrationSettingsRes
• MigrationStat
• Money
• NewStorageAccount
• OAuth2DeviceCodeResponse
• OAuthToken
• Organization
• PageMigration
• PageUserStat
• Pageable
• PasswordResetToken
• Payment
• PaymentOptions
• PolicyRule
• Price
• PriceConstraints
• PriceList
• PublicAuthenticationConfiguration
• PublicManagementServerConfiguration
• RefreshTokenRequest
• RequestResetPasswordRequest
• ResetPasswordRequest
• ResetSsoRequest
• SetLimitsRequest
• SetRolesRequest
• SetUserStateRequest
• SignUpRequest
• SignupCodeReq
• SignupCodeRes
• SignupCodeStat
• SignupResult
• Slot
• SlotStat
• Sort
• StorageAccount
• StorageAccountSettings
• StorageAccountSettingsReq
• StorageAccountSettingsRes
• StorageAccountStat
• StorageAccountWithBuckets
• StorageAccountsRequest
• StorageProvider
• TokenByDeviceCodeRequest
• TokenConfiguration
• UpdateUserRequest
• User
• UserConfig
• UserProfile
• UserSettings
• UserStat
• VirtualBucket
• VirtualBucketAccessPolicy
• VirtualBucketSettings
• VirtualBucketStorage
• VirtualBucketStorageSettings
• VirtualBucketStoragesRequest

Documentation for Authorization

Authentication schemes defined for the API:

Bearer

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Contact us:

• Information: [email protected]
• Sales: [email protected]
• Support: [email protected]