Skip to main content
GET
/
defaultClusterAdvancedSettings
List default cluster advanced settings
curl --request GET \
  --url https://api.qovery.com/defaultClusterAdvancedSettings \
  --header 'Authorization: <api-key>'
{
  "aws.cloudwatch.eks_logs_retention_days": 123,
  "aws.vpc.enable_s3_flow_logs": true,
  "aws.vpc.flow_logs_retention_days": 123,
  "loki.log_retention_in_week": 123,
  "registry.image_retention_time": 123,
  "cloud_provider.container_registry.tags": {},
  "aws.eks.enable_alb_controller": true,
  "load_balancer.size": "<string>",
  "database.postgresql.deny_any_access": true,
  "database.postgresql.allowed_cidrs": [
    "<string>"
  ],
  "database.mysql.deny_any_access": true,
  "database.mysql.allowed_cidrs": [
    "<string>"
  ],
  "database.mongodb.deny_any_access": true,
  "database.mongodb.allowed_cidrs": [
    "<string>"
  ],
  "database.redis.deny_any_access": true,
  "database.redis.allowed_cidrs": [
    "<string>"
  ],
  "aws.iam.admin_group": "<string>",
  "aws.eks.ec2.metadata_imds": "optional",
  "pleco.resources_ttl": 123,
  "registry.mirroring_mode": "Service",
  "nginx.vcpu.request_in_milli_cpu": 123,
  "nginx.vcpu.limit_in_milli_cpu": 123,
  "nginx.memory.request_in_mib": 123,
  "nginx.memory.limit_in_mib": 123,
  "nginx.hpa.cpu_utilization_percentage_threshold": 123,
  "nginx.hpa.min_number_instances": 123,
  "nginx.hpa.max_number_instances": 123,
  "storageclass.fast_ssd": "<string>",
  "qovery.static_ip_mode": true,
  "k8s.api.allowed_public_access_cidrs": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Response

Default cluster advanced settings

​
aws.cloudwatch.eks_logs_retention_days
integer

Set the number of retention days for EKS Cloudwatch logs

​
aws.vpc.enable_s3_flow_logs
boolean

Enable flow logs for on the VPC and store them in an S3 bucket

​
aws.vpc.flow_logs_retention_days
integer

Set the number of retention days for flow logs. Disable with value "0"

​
loki.log_retention_in_week
integer

For how long in week loki is going to keep logs of your applications

​
registry.image_retention_time
integer

Configure the number of seconds before cleaning images in the registry

​
cloud_provider.container_registry.tags
object

Add additional tags on the cluster dedicated registry

​
aws.eks.enable_alb_controller
boolean
default:true

Enable the AWS ALB controller to manage the load balancer for the cluster. Note: Changing this feature will create a 10 min max downtime on your application's public access (time to delete, replace and propagate DNS of the new load balancer) and will requiere to update all services with TCP/UDP open ports.

​
load_balancer.size
string

Select the size of the main load_balancer (only effective for Scaleway)

​
database.postgresql.deny_any_access
boolean

Deny public access to any PostgreSQL database

​
database.postgresql.allowed_cidrs
string[]

List of CIDRs allowed to access the PostgreSQL database

​
database.mysql.deny_any_access
boolean

Deny public access to any MySql database

​
database.mysql.allowed_cidrs
string[]

List of CIDRs allowed to access the MySql database

​
database.mongodb.deny_any_access
boolean

Deny public access to any MongoDB/DocumentDB database

​
database.mongodb.allowed_cidrs
string[]

List of CIDRs allowed to access the MongoDB/DocumentDB database

​
database.redis.deny_any_access
boolean

Deny public access to any Redis database

​
database.redis.allowed_cidrs
string[]

List of CIDRs allowed to access the Redis database

​
aws.iam.admin_group
string

AWS IAM group name with cluster access

​
aws.eks.ec2.metadata_imds
enum<string>

Specify the IMDS version you want to use:

  • required: IMDS V2 only
  • optional: IMDS V1 + V2
Available options:
optional,
required
​
pleco.resources_ttl
integer
deprecated
​
registry.mirroring_mode
enum<string>
default:Service

Mirroring mode when deploying a service from a container registry

  • Cluster: This is not available on Scaleway. Images within the mirroring registry are organized by "Qovery cluster", meaning that the application deployed on the same cluster are all mirrored on the same repository.
  • Service: Images within the mirroring registry are organized by "Qovery service", each service has its own repository
Available options:
Cluster,
Service
​
nginx.vcpu.request_in_milli_cpu
integer

vcpu request in millicores

​
nginx.vcpu.limit_in_milli_cpu
integer

vcpu limit in millicores

​
nginx.memory.request_in_mib
integer

memory request in MiB

​
nginx.memory.limit_in_mib
integer

memory limit in MiB

​
nginx.hpa.cpu_utilization_percentage_threshold
integer

hpa cpu threshold in percentage

​
nginx.hpa.min_number_instances
integer

hpa minimum number of instances

​
nginx.hpa.max_number_instances
integer

hpa maximum number of instances

​
storageclass.fast_ssd
string

storage class name to use to provision pvc

​
qovery.static_ip_mode
boolean

To limit public access from the internet to your Kubernetes cluster endpoint. You can define whitelisted CIDR in k8s.api.allowed_public_access_cidrs.

​
k8s.api.allowed_public_access_cidrs
string[]

Set custom sources to public access endpoint. Use CIDR notation to specify an IP address range (for example, ['203.0.113.5/32','203.0.100/32'])