From 1eb060828582bfc5c01b72159a604d0554234773 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 26 Oct 2023 15:49:25 +0000 Subject: [PATCH] Publish docs --- index.html | 14 +++++++------- openapi.yaml | 3 +++ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/index.html b/index.html index c7cd4a84..477a4961 100644 --- a/index.html +++ b/index.html @@ -3357,7 +3357,7 @@

Response samples

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

Create an application

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Create an application

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects
Array of objects
name
required
string

name is case insensitive

description
string or null

give a description to this application

required
object (ApplicationGitRepositoryRequest)
build_mode
string (BuildModeEnum)
Default: "BUILDPACKS"
Enum: "BUILDPACKS" "DOCKER"

DOCKER requires dockerfile_path @@ -3379,7 +3379,7 @@

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

List all environment applications statuses

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

+

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

List all environment applications statuses

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

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

Containers

List all container registry container statuses

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

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

Containers

List all container registry container statuses

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

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

containerRegistryId
required
string <uuid>

Container Registry ID

Responses

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

Edit application

    +

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

Edit application

  • To edit the application you must have the admin permission.
  • For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it.
  • For storage edition, if you provide a storage id, we will update the corresponding storage. If you don't we will create a new one. If you remove a storage from the payload, we will delete it.
    • @@ -3988,7 +3988,7 @@

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

Delete application

To delete the application you must have the admin permission

+

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

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",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true
}

Delete application

To delete the application you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

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

Remove an application from this database

Authorizations:
bearerAuthApiKeyAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

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

Remove an application from this database

Authorizations:
bearerAuthApiKeyAuth
path Parameters
databaseId
required
string <uuid>

Database ID

targetApplicationId
required
string <uuid>

Target application 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
}