From 7777fded54f16c065ccbbdf83297ae26c5db67a4 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 7 Sep 2023 12:03:08 +0000 Subject: [PATCH] Publish docs --- index.html | 8 ++++---- openapi.yaml | 8 ++++++++ 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/index.html b/index.html index 4365dda4..32cdeeb2 100644 --- a/index.html +++ b/index.html @@ -2621,7 +2621,7 @@

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a cluster

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a cluster

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string

name is case-insensitive

description
string
region
required
string
cloud_provider
required
string (CloudProviderEnum)
Enum: "AWS" "DO" "SCW"
min_running_nodes
integer
Default: 1
max_running_nodes
integer
Default: 1
disk_size
integer
Default: 20

Unit is in GB. The disk size to be used for the node configuration

instance_type
string

the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType

@@ -2632,7 +2632,7 @@

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "cpu": 10000,
  • "memory": 4096,
  • "estimated_cloud_provider_cost": 0,
  • "status": "BUILDING",
  • "has_access": true,
  • "version": "string",
  • "is_default": true,
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

List all clusters statuses

Returns a list of clusters with only their id and status.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "cpu": 10000,
  • "memory": 4096,
  • "estimated_cloud_provider_cost": 0,
  • "status": "BUILDING",
  • "has_access": true,
  • "version": "string",
  • "is_default": true,
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ],
  • "deployment_status": "NEVER_DEPLOYED"
}

List all clusters statuses

Returns a list of clusters with only their id and status.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "cpu": 10000,
  • "memory": 4096,
  • "estimated_cloud_provider_cost": 0,
  • "status": "BUILDING",
  • "has_access": true,
  • "version": "string",
  • "is_default": true,
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Get cluster status

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "cpu": 10000,
  • "memory": 4096,
  • "estimated_cloud_provider_cost": 0,
  • "status": "BUILDING",
  • "has_access": true,
  • "version": "string",
  • "is_default": true,
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ],
  • "deployment_status": "NEVER_DEPLOYED"
}

Get cluster status

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}