QoveryApi.CloudProviderApi

All URIs are relative to https://api.qovery.com

Method	HTTP request	Description
listAWSEKSInstanceType	GET /aws/eks/instanceType/{region}	List AWS EKS available instance types
listAWSEc2InstanceType	GET /aws/ec2/instanceType/{region}	List AWS EC2 available instance types
listAWSFeatures	GET /aws/clusterFeature	List AWS features available
listAWSInstanceType	GET /aws/instanceType	List AWS available instance types
listAWSManagedDatabaseInstanceType	GET /aws/managedDatabase/instanceType/{region}/{databaseType}	List AWS available managed database instance types
listAWSManagedDatabaseType	GET /aws/managedDatabase/type	List AWS available managed database types
listAWSRegions	GET /aws/region	List AWS regions
listCloudProvider	GET /cloudProvider	List Cloud providers available
listGcpFeatures	GET /gcp/clusterFeature	List GCP features available
listGcpGkeInstanceType	GET /gcp/instanceType/{region}	List GCP GKE available instance types
listGcpRegions	GET /gcp/region	List GCP regions
listSCWManagedDatabaseInstanceType	GET /scaleway/managedDatabase/instanceType/{zone}/{databaseType}	List Scaleway available managed database instance types
listSCWManagedDatabaseType	GET /scaleway/managedDatabase/type	List Scaleway available managed database types
listScalewayFeatures	GET /scaleway/clusterFeature	List Scaleway features available
listScalewayInstanceType	GET /scaleway/instanceType	List Scaleway available instance types
listScalewayKapsuleInstanceType	GET /scaleway/instanceType/{zone}	List Scaleway Kapsule available instance types
listScalewayRegions	GET /scaleway/region	List Scaleway regions

listAWSEKSInstanceType

ClusterInstanceTypeResponseList listAWSEKSInstanceType(region)

List AWS EKS available instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
let region = us-east-2; // String | region name
apiInstance.listAWSEKSInstanceType(region, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
region	String	region name

Return type

ClusterInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAWSEc2InstanceType

ClusterInstanceTypeResponseList listAWSEc2InstanceType(region)

List AWS EC2 available instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
let region = us-east-2; // String | region name
apiInstance.listAWSEc2InstanceType(region, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
region	String	region name

Return type

ClusterInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAWSFeatures

ClusterFeatureResponseList listAWSFeatures()

List AWS features available

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listAWSFeatures((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterFeatureResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAWSInstanceType

ClusterInstanceTypeResponseList listAWSInstanceType()

List AWS available instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listAWSInstanceType((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAWSManagedDatabaseInstanceType

ManagedDatabaseInstanceTypeResponseList listAWSManagedDatabaseInstanceType(region, databaseType)

List AWS available managed database instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
let region = us-east-2; // String | region name
let databaseType = MYSQL; // String | Database type
apiInstance.listAWSManagedDatabaseInstanceType(region, databaseType, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
region	String	region name
databaseType	String	Database type

Return type

ManagedDatabaseInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAWSManagedDatabaseType

ManagedDatabaseTypeResponseList listAWSManagedDatabaseType()

List AWS available managed database types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listAWSManagedDatabaseType((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ManagedDatabaseTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAWSRegions

ClusterRegionResponseList listAWSRegions()

List AWS regions

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listAWSRegions((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterRegionResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listCloudProvider

CloudProviderResponseList listCloudProvider()

List Cloud providers available

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listCloudProvider((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

CloudProviderResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listGcpFeatures

ClusterFeatureResponseList listGcpFeatures()

List GCP features available

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listGcpFeatures((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterFeatureResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listGcpGkeInstanceType

ClusterInstanceTypeResponseList listGcpGkeInstanceType(region)

List GCP GKE available instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
let region = us-east-2; // String | region name
apiInstance.listGcpGkeInstanceType(region, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
region	String	region name

Return type

ClusterInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listGcpRegions

ClusterRegionResponseList listGcpRegions()

List GCP regions

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listGcpRegions((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterRegionResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listSCWManagedDatabaseInstanceType

ManagedDatabaseInstanceTypeResponseList listSCWManagedDatabaseInstanceType(databaseType)

List Scaleway available managed database instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
let databaseType = MYSQL; // String | Database type
apiInstance.listSCWManagedDatabaseInstanceType(databaseType, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseType	String	Database type

Return type

ManagedDatabaseInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listSCWManagedDatabaseType

ManagedDatabaseTypeResponseList listSCWManagedDatabaseType()

List Scaleway available managed database types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listSCWManagedDatabaseType((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ManagedDatabaseTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listScalewayFeatures

ClusterFeatureResponseList listScalewayFeatures()

List Scaleway features available

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listScalewayFeatures((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterFeatureResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listScalewayInstanceType

ClusterInstanceTypeResponseList listScalewayInstanceType()

List Scaleway available instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listScalewayInstanceType((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listScalewayKapsuleInstanceType

ClusterInstanceTypeResponseList listScalewayKapsuleInstanceType(zone)

List Scaleway Kapsule available instance types

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
let zone = fr-par-1; // String | zone name
apiInstance.listScalewayKapsuleInstanceType(zone, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
zone	String	zone name

Return type

ClusterInstanceTypeResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

listScalewayRegions

ClusterRegionResponseList listScalewayRegions()

List Scaleway regions

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.CloudProviderApi();
apiInstance.listScalewayRegions((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ClusterRegionResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

Uh oh!

FilesExpand file tree

CloudProviderApi.md

Latest commit

History

CloudProviderApi.md

File metadata and controls

QoveryApi.CloudProviderApi

listAWSEKSInstanceType

Example

Parameters

Return type

Authorization

HTTP request headers

listAWSEc2InstanceType

Example

Parameters

Return type

Authorization

HTTP request headers

listAWSFeatures

Example

Parameters

Return type

Authorization

HTTP request headers

listAWSInstanceType

Example

Parameters

Return type

Authorization

HTTP request headers

listAWSManagedDatabaseInstanceType

Example

Parameters

Return type

Authorization

HTTP request headers

listAWSManagedDatabaseType

Example

Parameters

Return type

Authorization

HTTP request headers

listAWSRegions

Example

Parameters

Return type

Authorization

HTTP request headers

listCloudProvider

Example

Parameters

Return type

Authorization

HTTP request headers

listGcpFeatures

Example

Parameters

Return type

Authorization

HTTP request headers

listGcpGkeInstanceType

Example

Parameters

Return type

Authorization

HTTP request headers

listGcpRegions

Example

Parameters

Return type

Authorization

HTTP request headers

listSCWManagedDatabaseInstanceType

Example

Parameters

Return type

Authorization

HTTP request headers