{ "opencollection": "1.0.0", "info": { "name": "Qovery Account Info Clusters API", "version": "1.0.4" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Clusters", "type": "folder" }, "items": [ { "info": { "name": "List organization clusters", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List organization clusters" }, { "info": { "name": "Create a cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/organization/:organizationId/cluster", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a cluster" }, { "info": { "name": "List all clusters statuses", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/status", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Returns a list of clusters with only their id and status." }, { "info": { "name": "Edit a cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a cluster" }, { "info": { "name": "Delete a cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "deleteMode", "value": "", "type": "query" } ] }, "docs": "Delete a cluster" }, { "info": { "name": "Get cluster status", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/status", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Get cluster status" }, { "info": { "name": "Get cluster helm values for self managed installation", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/installationHelmValues", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Get cluster helm values for self managed installation" }, { "info": { "name": "Get cluster kubeconfig", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/kubeconfig", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "with_token_from_cli", "value": "", "type": "query", "description": "If true, the user auth part will have an exec command with qovery cli" } ] }, "docs": "Get cluster kubeconfig" }, { "info": { "name": "Edit cluster kubeconfig", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/kubeconfig", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Edit cluster kubeconfig" }, { "info": { "name": "Get advanced settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/advancedSettings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Get the list and values of the advanced settings of the cluster.\nDefault values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/cluster-advanced-settings/)\n" }, { "info": { "name": "Edit advanced settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/advancedSettings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit advanced settings by returning table of advanced settings." }, { "info": { "name": "Get routing table", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/routingTable", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Retrieve network routing table where each line corresponds to a route between a destination and a target." }, { "info": { "name": "Edit routing table", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/routingTable", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit routing table by returning updated table." }, { "info": { "name": "List Cluster Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/logs", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "List Cluster Logs" }, { "info": { "name": "Get cluster cloud provider info and credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/cloudProviderInfo", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Get cluster cloud provider info and credentials" }, { "info": { "name": "Specify cluster cloud provider info and credentials", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/cloudProviderInfo", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Specify cluster cloud provider info and credentials" }, { "info": { "name": "Know if a cluster is ready to be deployed or not", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/isReady", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Know if a cluster is ready to be deployed or not" }, { "info": { "name": "Deploy a cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/deploy", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "dry_run", "value": "", "type": "query", "description": "default: false. Decide if the deployment of the cluster should be done in dry_run mode. Avoiding any changes" } ] }, "docs": "allows to deploy a cluster" }, { "info": { "name": "List EKS Anywhere commits", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/eks-anywhere/commits", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Returns list of the last commits made on the repository linked to the EKS Anywhere cluster, filtered by the targeted YAML file when supported by provider." }, { "info": { "name": "Update selected EKS Anywhere commit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/eks-anywhere/commit", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Persist selected commit for an EKS Anywhere cluster." }, { "info": { "name": "Get latest EKS Anywhere cluster JWT", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/eks-anywhere/jwt", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Returns the latest valid JWT currently used for engine deployments for the specified EKS Anywhere cluster." }, { "info": { "name": "Upgrade a cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/cluster/:clusterId/upgrade", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "allows to upgrade a cluster to next available kubernetes version" }, { "info": { "name": "Update karpenter private fargate subnet ids", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/karpenterPrivateSubnetIds", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update karpenter private fargate subnet ids" }, { "info": { "name": "Stop cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/organization/:organizationId/cluster/:clusterId/stop", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" } ] }, "docs": "Cluster stop has been requester." }, { "info": { "name": "List default cluster advanced settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/defaultClusterAdvancedSettings" }, "docs": "Default values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/cluster-advanced-settings/)" }, { "info": { "name": "List environments services by cluster id", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/cluster/:clusterId/environments", "params": [ { "name": "clusterId", "value": "", "type": "path" } ] }, "docs": "List environments services by cluster id" }, { "info": { "name": "Lock Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/cluster/:clusterId/lock", "params": [ { "name": "clusterId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lock a Cluster" }, { "info": { "name": "Unlock Cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qovery.com/cluster/:clusterId/lock", "params": [ { "name": "clusterId", "value": "", "type": "path" } ] }, "docs": "Unlock a cluster" }, { "info": { "name": "List Cluster Kubernetes Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/cluster/:clusterId/events", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "from_date_time", "value": "2025-03-03T09:00:00+00:00", "type": "query", "description": "The start date time to fetch events from, following ISO-8601 format. \nThe `+` character must be escaped (`%2B`)\n" }, { "name": "to_date_time", "value": "2025-03-03T03:00:00+00:00", "type": "query", "description": "The end date time to fetch events from, following ISO-8601 format. \nThe `+` character must be escaped (`%2B`)\n" }, { "name": "node_name", "value": "", "type": "query", "description": "The name of the node to fetch event from" }, { "name": "pod_name", "value": "", "type": "query", "description": "The name of the pod to fetch event from" }, { "name": "reporting_component", "value": "", "type": "query", "description": "The name of the reporting component used to filter events." } ] }, "docs": "List Cluster Kubernetes Events" }, { "info": { "name": "Fetch cluster metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/cluster/:clusterId/metrics", "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "Cluster ID" }, { "name": "endpoint", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "step", "value": "", "type": "query" }, { "name": "time", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" }, { "name": "dedup", "value": "", "type": "query" }, { "name": "partial_response", "value": "", "type": "query" }, { "name": "max_source_resolution", "value": "", "type": "query" }, { "name": "engine", "value": "", "type": "query" }, { "name": "analyze", "value": "", "type": "query" }, { "name": "board_short_name", "value": "", "type": "query" }, { "name": "metric_short_name", "value": "", "type": "query" }, { "name": "trace_id", "value": "", "type": "query" }, { "name": "range", "value": "", "type": "query" } ] }, "docs": "Fetch cluster metrics." }, { "info": { "name": "Fetch cluster logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/cluster/:clusterId/logs", "params": [ { "name": "clusterId", "value": "", "type": "path" }, { "name": "endpoint", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "step", "value": "", "type": "query" }, { "name": "interval", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "time", "value": "", "type": "query" } ] }, "docs": "Fetch cluster logs" } ] } ], "bundled": true }